Skip to content

Commit 848e44f

Browse files
committed
website: re-generate commons
1 parent d466228 commit 848e44f

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

+106
-215
lines changed

website/README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,3 @@ The folder was created with:
88
```sh
99
npx create-docusaurus website classic --typescript
1010
```
11-
12-
## docusaurus-plugin-typedoc
13-
14-
This plugin uses [TypeDoc](https://typedoc.org) to generate
15-
the reference as markdown pages in `docs/api`.
16-
17-
- https://typedoc-plugin-markdown.org/plugins/docusaurus
18-
19-
```sh
20-
cd website
21-
npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
22-
```
23-
24-
[!NOTE]
25-
There is a new spec ([TSDoc](https://tsdoc.org)), pushed by
26-
Microsoft, slightly different, for example there are no
27-
categories or groups.
28-
29-
[!NOTE]
30-
There is also another plugin, `docusaurus-plugin-typedoc-api`, but
31-
it is no longer maintained.

website/docs/_shared/_development-durations.mdx

Lines changed: 0 additions & 13 deletions
This file was deleted.

website/docs/_shared/_github-actions-durations.mdx

Lines changed: 0 additions & 11 deletions
This file was deleted.

website/docs/_shared/_release-schedule.mdx

Lines changed: 0 additions & 14 deletions
This file was deleted.

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,3 @@ 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)
1515
program.
16-
17-
Thanks to [Shields IO](https://shields.io) for the badges.

website/docs/getting-started/_common/_details-reproducible-builds.mdx renamed to website/docs/getting-started/_common/_details-reproducible-operations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
{/* ------------------------------------------------------------------------ */}
55

66
<details>
7-
<summary>What are reproducible builds?</summary>
7+
<summary>What are reproducible operations?</summary>
88

99
To be **reproducible**, an operation must remain stable over time and
10-
across different environments. In other words, if builds are repeated
10+
across different environments. In other words, if the same operation is repeated
1111
after some time, possibly on a different machine or platform, the
1212
resulting behaviour must be functionally equivalent.
1313

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
If you enjoyed using this project, please let us know! Here are some ways you can show your support:
99

10-
- **Donate**: Your contributions, whether small or generous, help us keep the xPack projects thriving. [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?hosted_button_id=5MFRG9ZRBETQ8)
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)
1113
- **Star** the project on [GitHub](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/): It helps others discover our work.
1214
- **Follow** us on [X/Twitter](https://twitter.com/xpack_project/): Stay updated with our latest releases and news.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:::info Separate User/Contributor/Maintainer pages
77

8-
To meet the specific needs of different
8+
To address the specific needs of different
99
audiences, this site features separate
1010
**[User's Guide](/docs/user/)**,
1111
**[Contributor's Guide](/docs/developer/)** and
Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
{/* DO NOT EDIT! */}
2-
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
1+
import CommonDetailsReproducibleBuilds from '../_common/_details-reproducible-operations.mdx';
2+
import CommonWhatAreXpmPackages from '../_common/_what-are-xpm-packages.mdx';
3+
import CommonFeatures from '../_common/_features.mdx';
4+
import CommonBenefits from '../_common/_benefits.mdx';
5+
import CommonInstallPreamble from '../_common/_install-preamble.mdx';
6+
import CommonCreditsMacStadium from '../_common/_credits-mac-stadium.mdx';
37

4-
import DetailsReproducibleBuilds from '../_common/_details-reproducible-builds.mdx';
5-
import WhatAreXpmPackages from '../_common/_what-are-xpm-packages.mdx';
6-
import Features from '../_common/_features.mdx';
7-
import Benefits from '../_common/_benefits.mdx';
8-
import InstallPreamble from '../_common/_install-preamble.mdx';
8+
import CommonLicense from '../_common/_license.mdx';
9+
import CommonEnjoyedUsing from '../_common/_enjoyed-using.mdx';
910

10-
import License from '../_common/_license.mdx';
11-
import Credits from '../_common/_credits.mdx';
12-
import EnjoyedUsing from '../_common/_enjoyed-using.mdx';
13-
14-
import Overview from './_overview.mdx';
15-
import OtherBenefits from './_other-benefits.mdx';
16-
import UpgradeNotice from './_upgrade-notice.mdx';
17-
import Compatibility from './_compatibility.mdx';
11+
import ProjectOverview from '../_project/_overview.mdx';
12+
import ProjectOtherBenefits from '../_project/_other-benefits.mdx';
13+
import ProjectCompatibility from '../_project/_compatibility.mdx';
1814

1915
{/* ------------------------------------------------------------------------ */}
2016

@@ -23,34 +19,34 @@ import Compatibility from './_compatibility.mdx';
2319

2420
**xPack Binary Development Tools** is a collection of standalone cross-platform binary tools, aimed at reproducible builds.
2521

26-
<DetailsReproducibleBuilds />
22+
<CommonDetailsReproducibleBuilds />
2723

28-
<Overview/>
24+
<ProjectOverview/>
2925

30-
<WhatAreXpmPackages />
26+
<CommonWhatAreXpmPackages />
3127

32-
<Features />
28+
<CommonFeatures />
3329

34-
<Benefits />
30+
<CommonBenefits />
3531

36-
<OtherBenefits/>
32+
<ProjectOtherBenefits/>
3733

38-
<Compatibility/>
34+
<ProjectCompatibility/>
3935

4036
## Install
4137

42-
<InstallPreamble />
38+
<CommonInstallPreamble />
4339

4440
The details for installing the various **xPack Binary Development Tools**
4541
on different platforms are provided in the
4642
**Install Guide** on each project's website.
4743

48-
<License />
44+
<CommonLicense />
4945

5046
The binary distributions include several open-source components;
5147
the corresponding licenses are available in each archive in the
5248
`distro-info/licenses` folder.
5349

54-
<Credits />
50+
<CommonCreditsMacStadium />
5551

56-
<EnjoyedUsing />
52+
<CommonEnjoyedUsing />

website/docs/getting-started/_project/_overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{/* ------------------------------------------------------------------------ */}
33

44
The project home page groups the available tools as main tools
5-
and suplementary tools.
5+
and supplementary tools.
66

77
All projects are open source and are hosted in the GitHub Organization
88
[`xpack-dev-tools`](https://github.com/xpack-dev-tools/).

website/docs/maintainer/_common/_generate-top-commons.mdx

Lines changed: 0 additions & 17 deletions
This file was deleted.

website/docs/maintainer/_project/_check-upstream-release.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

website/docs/maintainer/_project/_first-development-run.mdx

Lines changed: 0 additions & 2 deletions
This file was deleted.

website/docs/maintainer/_project/_first-production-run.mdx

Lines changed: 0 additions & 2 deletions
This file was deleted.

website/docs/maintainer/_project/_more-repos.mdx

Lines changed: 0 additions & 6 deletions
This file was deleted.

website/docs/maintainer/_project/_more-tests.mdx

Lines changed: 0 additions & 2 deletions
This file was deleted.

website/docs/maintainer/_project/_patches.mdx

Lines changed: 0 additions & 6 deletions
This file was deleted.

website/docs/maintainer/_project/_share-custom.mdx

Lines changed: 0 additions & 2 deletions
This file was deleted.

website/docs/maintainer/_project/_update-version-specific.mdx

Lines changed: 0 additions & 7 deletions
This file was deleted.

website/docs/project/about/_common/_the-project.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
In **{props.date || 'DATE'}**, as part of the project restructuring,
7+
the Docusaurus template was instantiated in the `website` folder,
8+
alongside the Doxygen configuration, which was retained for the reference
9+
pages.

website/docs/project/about/_common/_website-jekyll.mdx

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

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

6-
The initial web site was launched in **{props.date || 'DATE'}** as
7-
a sub-site in the xPack web site.
6+
The initial website was launched in **{props.date || 'DATE'}** as
7+
a sub-site in the xPack website.
88
It used the
99
[Jekyll Doc Theme 6.0](https://idratherbewriting.com/documentation-theme-jekyll/)
1010
by [Tom Johnson](https://github.com/tomjoht).
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11

2-
import TheProjectHistory from '../_common/_the-project-history.mdx';
2+
import CommonTheProjectHistory from '../_common/_the-project-history.mdx';
33

4-
import TheWebsite from '../_project/_website.mdx';
5-
6-
import TheAuthor from '../_common/_the-author.mdx';
4+
import ProjectTheWebsite from '../_project/_website.mdx';
5+
import ProjectTheAuthor from '../_common/_the-author.mdx';
76

87
{/* ------------------------------------------------------------------------ */}
98

@@ -14,8 +13,8 @@ The **xPack Binary Development Tools** project is part of the
1413
and is hosted on GitHub as
1514
[`xpack-dev-tools`](https://github.com/xpack-dev-tools/).
1615

17-
<TheProjectHistory />
16+
<CommonTheProjectHistory />
1817

19-
<TheWebsite />
18+
<ProjectTheWebsite />
2019

21-
<TheAuthor />
20+
<ProjectTheAuthor />

website/docs/project/history/_common/History32bitDiscontinued/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function History32bitDiscontinued({platforms}): JSX.Element {

website/docs/project/history/_common/HistoryAppleSiliconAdded/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryAppleSiliconAdded(): JSX.Element {

website/docs/project/history/_common/HistoryArmLinuxAdded/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryArmLinuxAdded(): JSX.Element {

website/docs/project/history/_common/HistoryPlatformsAdded/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryPlatformsAdded({platforms}): JSX.Element {

website/docs/project/history/_common/HistoryRenameXpack/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryRenameXpack(): JSX.Element {

website/docs/project/history/_common/HistoryWindowsUcrt/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryWindowsUcrt(): JSX.Element {

website/docs/project/history/_common/HistoryXpm/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryXpm({specifier}): JSX.Element {

website/docs/project/history/_common/HistoryZipAdded/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* for any purpose is hereby granted, under the terms of the MIT license.
1010
*
1111
* If a copy of the license was not distributed with this file, it can
12-
* be obtained from https://opensource.org/licenses/MIT/.
12+
* be obtained from https://opensource.org/licenses/MIT.
1313
*/
1414

1515
export default function HistoryZipAdded({platforms}): JSX.Element {

0 commit comments

Comments
 (0)