Skip to content

Commit 820a329

Browse files
committed
website: re-generate commons
1 parent 64a98de commit 820a329

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+6528
-2569
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
By design, xpm utilises symbolic links to folders (junction points on
7+
NTFS) to facilitate the sharing of common packages across projects. Any
8+
attempt to install packages on a drive that does not support symbolic
9+
links will result in an error:
10+
11+
```
12+
error: volume X: does not support links, it might not be NTFS, or it might be a remote resource
13+
```
14+
15+
Utilise a recent version of Windows and format the drive as NTFS.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
### Update the top commons
7+
8+
Execute the top **generate-top-commons** npm script to update the
9+
`build-assets/package.json` and the GitHub workflow files.
10+
11+
```sh
12+
npm run generate-top-commons -C ~/Work/xpack-dev-tools/xpack-build-box.git
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
### Update the website commons
7+
8+
Execute the **generate-website-commons** npm script from `website/package.json`
9+
within the project folder.
10+
11+
```sh
12+
npm run generate-website-commons -C ~/Work/xpack-dev-tools/xpack-build-box.git/website
13+
```

website/docs/getting-started/_common/_credits-mac-stadium.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Link from '@docusaurus/Link';
99

1010
## Credits
1111

12-
Special thanks to **MacStadium**, for providing the Apple Silicon
12+
Special thanks to **MacStadium** for providing the Apple Silicon
1313
development infrastructure as part of their generous
1414
[Free and Open Source Software](https://www.macstadium.com/company/opensource)
15-
program.
15+
programme.

website/docs/getting-started/_common/_enjoyed-using.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@
33

44
{/* ------------------------------------------------------------------------ */}
55

6-
## Enjoyed Using This Project? Let Us Know!
6+
## Enjoyed Using This Project? Please Let Us Know!
77

8-
If you enjoyed using this project, please let us know! Here are some ways you can show your support:
8+
If you have found this project valuable, we would appreciate hearing from you!
9+
Here are some ways you can demonstrate your support:
910

10-
- **Donate**: Your contributions, whether small or generous, help us keep the
11-
xPack
12-
projects thriving. [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?hosted_button_id=5MFRG9ZRBETQ8)
13-
- **Star** the project on [GitHub](https://github.com/xpack-dev-tools/xpack-build-box/): It helps others discover our work.
14-
- **Follow** us on [X/Twitter](https://twitter.com/xpack_project/): Stay updated with our latest releases and news.
11+
- **Donate**: Every contribution, regardless of size, helps sustain the
12+
xPack project.
13+
Your generosity maintains the development and ensures continued progress.
14+
- **Star** the project on [GitHub](https://github.com/xpack-dev-tools/xpack-build-box/):
15+
Assist others in discovering our work by giving it a star — it truly makes a difference!
16+
- **Follow Us** on [X/Twitter](https://twitter.com/xpack_project/): Stay informed about our latest updates, releases,
17+
and news by following our account.
18+
19+
Your support is greatly appreciated and motivates us to continue improving!

website/docs/getting-started/_common/_license.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
{/* ------------------------------------------------------------------------ */}
55

6-
## License
6+
## Licence
77

8-
Unless otherwise stated, the original content is released under the terms of the
9-
[MIT License](https://opensource.org/license/mit/),
10-
with all rights reserved by
11-
[Liviu Ionescu](https://github.com/ilg-ul).
8+
Unless explicitly stated otherwise, the original content is
9+
distributed under the terms of the
10+
[MIT Licence](https://opensource.org/license/mit), with all
11+
rights reserved by [Liviu Ionescu](https://github.com/ilg-ul).

website/docs/getting-started/_common/_user-developer-maintainer.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
{/* ------------------------------------------------------------------------ */}
55

6-
:::info Separate User/Maintainer pages
6+
:::info Dedicated Pages for Different Audiences
77

8-
To address the specific needs of different
9-
audiences, this site features separate
8+
To accommodate the diverse requirements of its audience, this site provides
9+
distinct pages:
1010
**[User's Guide](/docs/user/)** and
11-
**[Maintainer's Guide](/docs/maintainer/)**
12-
pages. This way, each group can easily find the information and resources
13-
most relevant to them.
11+
**[Maintainer's Guide](/docs/maintainer/)**.
12+
Each guide is tailored to ensure users can efficiently access the
13+
information and resources most relevant to their specific roles or requirements.
1414

1515
:::
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
### Prerequisites
7+
8+
The only requirement for an automated installation is a recent
9+
[xpm](https://xpack.github.io/xpm/), which is a portable
10+
[Node.js](https://nodejs.org) command line application
11+
that complements [npm](https://docs.npmjs.com)
12+
with several additional features specific to
13+
**C/C++ projects**.
14+
15+
To install **xpm**,
16+
follow the instructions on the
17+
[xpm install](https://xpack.github.io/xpm/install/) page.
18+
19+
If already installed, it is always advisable to update it to the
20+
latest version with:
21+
22+
```sh
23+
npm install --location=global xpm@latest
24+
```
25+
26+
:::tip
27+
28+
Although not mandated by **xpm**, it is also advisable to upgrade
29+
**npm** to the latest version, and
30+
**node** to a reasonably recent version (currently **npm** requires
31+
a **node** >=18.17.0).
32+
33+
:::
34+
35+
<details>
36+
<summary>Local installations</summary>
37+
38+
One of the xPack design goals is to allow each project to
39+
select the exact versions of the libraries it requires.
40+
41+
Similarly to **npm** being able to install specific versions of the
42+
JavaScript tools into each project,
43+
**xpm** was also designed to be able to install specific versions of the
44+
required libraries locally into each project.
45+
46+
Therefore, similarly to the way **npm** installs the JavaScript packages into
47+
`node_modules`, **xpm** installs the libraries into
48+
`xpacks`. Here there will be separate folders with the installed
49+
packages, for example
50+
<code>xpacks/xpack-build-box</code>.
51+
52+
</details>

website/docs/install/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# DO NOT EDIT!
44
# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
55

6-
title: Install Guide
6+
title: Installation Guide
77
description: Explain the prerequisites, how to perform an automated installation, how to uninstall.
88
keywords:
99
- xpack
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
import versionMajor from '@site/src/libs/versionMajor';
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
The strategy with the development builds is to run them in descending order
7+
({versionMajor()}.2, {versionMajor() - 1}.3, {versionMajor() - 2}.4, {versionMajor() - 3}.5).
8+
9+
For this update the top `package.json` and `build-assets/scripts/VERSION` files
10+
and run the build scripts.
11+
12+
After each build, save the folder hierarchies and executables, to be used
13+
in the blog posts.
14+
15+
Then perform the steps to make the production builds in ascending order
16+
({versionMajor() - 3}.5, {versionMajor() - 2}.4, {versionMajor() - 1}.3, {versionMajor()}.2),
17+
with full tests and website updates.

0 commit comments

Comments
 (0)