Skip to content

Commit 55bdb44

Browse files
committed
website: re-generate descriptive & permalink names
1 parent 4766586 commit 55bdb44

5 files changed

+16
-16
lines changed

website/blog/_templates/blog-post-release-part-1-liquid.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22

3-
title: xPack {{packageConfig.longName}} v{{xpackVersion}} released
3+
title: xPack {{packageConfig.descriptiveName}} v{{xpackVersion}} released
44
seo_title: Version {{xpackVersion}} released
55
description: Version {{xpackVersion}} is a TODO new/maintenance release.
66
keywords:
77
- xpack
8-
- {{packageConfig.shortName}}
8+
- {{packageConfig.permalinkName}}
99
- release
1010

1111
date: {{releaseDate}}
@@ -79,10 +79,10 @@ The binary files are available from <a href={frontMatter.download_url}>GitHub Re
7979
The easiest way to install this specific version, is by using **xpm**:
8080

8181
<CodeBlock language="console"> {
82-
`xpm install @xpack-dev-tools/{{packageConfig.shortName}}@${frontMatter.version}.${frontMatter.npm_subversion} -verbose
82+
`xpm install @xpack-dev-tools/{{packageConfig.permalinkName}}@${frontMatter.version}.${frontMatter.npm_subversion} -verbose
8383
`} </CodeBlock>
8484

85-
Comprehensive instructions for installing **xPack {{packageConfig.longName}}** on different platforms
85+
Comprehensive instructions for installing **xPack {{packageConfig.descriptiveName}}** on different platforms
8686
can be found in the [Install Guide](/docs/install/).
8787

8888
## Compliance

website/docs/install/_common/_automatic-install-quick-test.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import TabItem from '@theme/TabItem';
99

1010
### Quick test
1111

12-
To check if the {props.longName} installed by **xpm** starts properly, use something like:
12+
To check if the {props.descriptiveName} installed by **xpm** starts properly, use something like:
1313

1414
<Tabs groupId="operating-systems">
1515

1616
<TabItem value="windows" label="Windows" default>
1717

1818
<CodeBlock language="console"> {
19-
`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${props.shortName}\\14.2.1-1.1.1\\.content\\bin\\${props.programName}.exe --version
19+
`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${props.permalinkName}\\14.2.1-1.1.1\\.content\\bin\\${props.programName}.exe --version
2020
${props.branding}14.2.1
2121
`} </CodeBlock>
2222

@@ -25,7 +25,7 @@ ${props.branding}14.2.1
2525
<TabItem value="macos" label="macOS">
2626

2727
<CodeBlock language="console"> {
28-
`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/14.2.1-1.1.1/.content/bin/${props.programName} --version
28+
`% ~/Library/xPacks/@xpack-dev-tools/${props.permalinkName}/14.2.1-1.1.1/.content/bin/${props.programName} --version
2929
${props.branding}14.2.1
3030
`} </CodeBlock>
3131

@@ -34,7 +34,7 @@ ${props.branding}14.2.1
3434
<TabItem value="linux" label="GNU/Linux">
3535

3636
<CodeBlock language="console"> {
37-
`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/14.2.1-1.1.1/.content/bin/${props.programName} --version
37+
`$ ~/.local/xPacks/@xpack-dev-tools/${props.permalinkName}/14.2.1-1.1.1/.content/bin/${props.programName} --version
3838
${props.branding}14.2.1
3939
`} </CodeBlock>
4040

website/docs/install/_common/_manual-install-quick-test.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import TabItem from '@theme/TabItem';
99

1010
### Quick test {#manual-install-quick-test}
1111

12-
To check if the {props.longName} installed manually starts properly, use something like:
12+
To check if the {props.descriptiveName} installed manually starts properly, use something like:
1313

1414
<Tabs groupId="operating-systems">
1515

1616
<TabItem value="windows" label="Windows" default>
1717

1818
<CodeBlock language="console"> {
19-
`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${props.shortName}\\xpack-${props.shortName}-14.2.1-1.1\\bin\\${props.programName}.exe --version
19+
`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${props.permalinkName}\\xpack-${props.permalinkName}-14.2.1-1.1\\bin\\${props.programName}.exe --version
2020
${props.branding}14.2.1
2121
`} </CodeBlock>
2222

@@ -25,7 +25,7 @@ ${props.branding}14.2.1
2525
<TabItem value="macos" label="macOS">
2626

2727
<CodeBlock language="console"> {
28-
`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-14.2.1-1.1/bin/${props.programName} --version
28+
`% ~/Library/xPacks/${props.permalinkName}/xpack-${props.permalinkName}-14.2.1-1.1/bin/${props.programName} --version
2929
${props.branding}14.2.1
3030
`} </CodeBlock>
3131

@@ -34,7 +34,7 @@ ${props.branding}14.2.1
3434
<TabItem value="linux" label="GNU/Linux">
3535

3636
<CodeBlock language="console"> {
37-
`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-14.2.1-1.1/bin/${props.programName} --version
37+
`$ ~/.local/xPacks/${props.permalinkName}/xpack-${props.permalinkName}-14.2.1-1.1/bin/${props.programName} --version
3838
${props.branding}14.2.1
3939
`} </CodeBlock>
4040

website/docs/install/_project/_automatic-install-quick-test.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import AutomaticInstallQuickTest from '../_common/_automatic-install-quick-test.
66
{/* ------------------------------------------------------------------------ */}
77

88
<AutomaticInstallQuickTest
9-
longName="GNU Arm Embedded GCC"
10-
shortName="arm-none-eabi-gcc"
9+
descriptiveName="GNU Arm Embedded GCC"
10+
permalinkName="arm-none-eabi-gcc"
1111
programName="arm-none-eabi-gcc"
1212
branding="arm-none-eabi-gcc (xPack GNU Arm Embedded GCC x86_64) "
1313
/>

website/docs/install/_project/_manual-install-quick-test.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import ManualInstallQuickTest from '../_common/_manual-install-quick-test.mdx';
66
{/* ------------------------------------------------------------------------ */}
77

88
<ManualInstallQuickTest
9-
longName="GNU Arm Embedded GCC"
10-
shortName="arm-none-eabi-gcc"
9+
descriptiveName="GNU Arm Embedded GCC"
10+
permalinkName="arm-none-eabi-gcc"
1111
programName="arm-none-eabi-gcc"
1212
branding="arm-none-eabi-gcc (xPack GNU Arm Embedded GCC x86_64) "
1313
/>

0 commit comments

Comments
 (0)