Skip to content

Commit cf0549e

Browse files
ilg-ulilg-ul
committed
regenerate website commons
1 parent 377b693 commit cf0549e

File tree

60 files changed

+5713
-3291
lines changed

Some content is hidden

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

60 files changed

+5713
-3291
lines changed

‎website/docs/_common/_symbolic-links-require-ntfs.mdx‎

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.

‎website/docs/_common/_update-top-commons.mdx‎

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-dev-tools.github.io.git
13+
```

‎website/docs/_common/_update-website-commons.mdx‎

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-dev-tools.github.io.git/website
13+
```

‎website/docs/getting-started/_common/_benefits.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55

66
## Benefits
77

8-
The main advantages of using the **xPack Binary Development Tools** are:
8+
The primary advantages of utilising the **xPack Binary Development Tools** are:
99

10-
- A convenient, uniform and portable install/uninstall/upgrade
11-
procedure; the same procedure is used for all major
12-
platforms (**x64 Windows**, **x64 macOS**, **arm64 macOS**, **x64 GNU/Linux**, **arm64 GNU/Linux**, **arm GNU/Linux**).
13-
- Multiple versions of the same package can be installed at the same time on
10+
- A convenient, uniform and portable installation/uninstallation/upgrade
11+
procedure; the same procedure is utilised for all major
12+
platforms (**x64 Windows**, **x64 macOS**, **arm64 macOS**, **x64 GNU/Linux**, **arm64 GNU/Linux**).
13+
- Multiple versions of the same package may be installed simultaneously on
1414
the same system.
15-
- No need to worry about dependent libraries, they are all included.
15+
- No need to be concerned about dependent libraries, as they are all included.
1616
- Not affected by system updates that
17-
might change the versions of the dependent libraries.
18-
- Significantly lighter and easier to use than Docker images that provide
17+
might alter the versions of the dependent libraries.
18+
- Significantly lighter and easier to utilise than Docker images that provide
1919
similar functionality and are GNU/Linux centric.
20-
- Projects can be tied to specific tools versions; this provides a good
21-
reproducibility, especially useful in **CI/CD** environments.
20+
- Projects may be tied to specific tool versions; this provides excellent
21+
reproducibility, particularly useful in **CI/CD** environments.

‎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-dev-tools.github.io/): 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-dev-tools.github.io/):
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/_features.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@
77

88
All binaries are:
99

10-
- **Self-contained** (include all required libraries).
11-
- **File-system relocatable** (can be installed in any location).
10+
- **Self-contained** (include all required libraries)
11+
- **File-system relocatable** (may be installed in any location)
1212
- Built on slightly older systems (to ensure compatibility with both
13-
old and new systems).
13+
old and new systems)
1414

1515
<details>
1616
<summary>Compatibility with older systems</summary>
1717

1818
Given that most operating systems maintain significant compatibility
1919
with older versions, building an application on an older system ensures
20-
that the same binary can run on newer versions. Conversely, building an
21-
application on a newer system may utilize library features that are
20+
that the same binary may execute on newer versions. Conversely, building an
21+
application on a newer system may utilise library features that are
2222
not available in older versions, making backward compatibility less
2323
feasible.
2424

2525
</details>
2626

27-
Similarly to [flatpacks](https://flatpak.org) or [snap](https://snapcraft.io),
27+
Similarly to [Flatpak](https://flatpak.org) or [Snap](https://snapcraft.io),
2828
but significantly simpler, xpm packages include all dependent shared libraries
2929
within the distributed archives, making the binaries independent of
3030
any similar libraries installed on the system. This ensures they
31-
can run on any system without needing specific libraries to be
31+
may execute on any system without requiring specific libraries to be
3232
installed.
3333

34-
Also the builds are configured so that the binaries do not depend on
35-
being installed in specific folders, and can be installed in any
36-
location, including in user folders.
34+
Additionally, the builds are configured so that the binaries do not depend on
35+
being installed in specific folders, and may be installed in any
36+
location, including within user folders.

‎website/docs/getting-started/_common/_install-preamble.mdx‎

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

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

6-
The executables and other related files can be installed automatically with
6+
The executables and other related files may be installed automatically with
77
**xpm** or manually by downloading the
8-
**platform specific archives**.
8+
**platform-specific archives**.

‎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,14 +3,14 @@
33

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

6-
:::info Separate User/Contributor/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/)**,
1111
**[Contributor's Guide](/docs/developer/)** and
12-
**[Maintainer's Guide](/docs/maintainer/)**
13-
pages. This way, each group can easily find the information and resources
14-
most relevant to them.
12+
**[Maintainer's Guide](/docs/maintainer/)**.
13+
Each guide is tailored to ensure users can efficiently access the
14+
information and resources most relevant to their specific roles or requirements.
1515

1616
:::

0 commit comments

Comments
 (0)