From 78f1ad0a726fc9cf3359d5a0a6b6c257aa1c7e0a Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Wed, 22 Jan 2025 13:15:28 +0200 Subject: [PATCH] website: re-generate commons --- website/blog/_common/_download-analytics.mdx | 4 +- website/docs/install/index.mdx | 8 +- .../about/_common/_intro-primary.mdx | 0 .../about/_common/_intro-secondary.mdx | 0 .../_common/_website-docusaurus-migration.mdx | 0 .../_common/_website-docusaurus-template.mdx | 0 .../about/_common/_website-jekyll.mdx | 0 .../docs/{ => project}/about/_more-intro.mdx | 0 website/docs/{ => project}/about/_website.mdx | 0 website/docs/{ => project}/about/index.mdx | 15 ++-- .../History32bitDiscontinued/index.tsx | 0 .../HistoryAppleSiliconAdded/index.tsx | 0 .../_common/HistoryArmLinuxAdded/index.tsx | 0 .../_common/HistoryPlatformsAdded/index.tsx | 0 .../_common/HistoryRenameXpack/index.tsx | 0 .../_common/HistoryWindowsUcrt/index.tsx | 0 .../history}/_common/HistoryXpm/index.tsx | 0 .../_common/HistoryZipAdded/index.tsx | 0 .../_common/_history-gnu-arm-eclipse.mdx | 0 .../_common/_history-rename-xpack.mdx | 0 .../_common/_history-restructuring.mdx | 0 .../_common/_history-setup-discontinued.mdx | 0 .../history}/_common/_history-xbb-v5.mdx | 0 .../{about => project/history}/_history.mdx | 0 website/docs/project/history/index.mdx | 20 +++++ website/docs/support/index.mdx | 77 ++++++++++++++++--- website/docusaurus-config-redirects.ts | 12 ++- website/docusaurus.config.ts | 6 +- website/package.json | 6 ++ website/sidebars.ts | 29 ++++++- 30 files changed, 142 insertions(+), 35 deletions(-) rename website/docs/{ => project}/about/_common/_intro-primary.mdx (100%) rename website/docs/{ => project}/about/_common/_intro-secondary.mdx (100%) rename website/docs/{ => project}/about/_common/_website-docusaurus-migration.mdx (100%) rename website/docs/{ => project}/about/_common/_website-docusaurus-template.mdx (100%) rename website/docs/{ => project}/about/_common/_website-jekyll.mdx (100%) rename website/docs/{ => project}/about/_more-intro.mdx (100%) rename website/docs/{ => project}/about/_website.mdx (100%) rename website/docs/{ => project}/about/index.mdx (85%) rename website/docs/{about => project/history}/_common/History32bitDiscontinued/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryAppleSiliconAdded/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryArmLinuxAdded/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryPlatformsAdded/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryRenameXpack/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryWindowsUcrt/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryXpm/index.tsx (100%) rename website/docs/{about => project/history}/_common/HistoryZipAdded/index.tsx (100%) rename website/docs/{about => project/history}/_common/_history-gnu-arm-eclipse.mdx (100%) rename website/docs/{about => project/history}/_common/_history-rename-xpack.mdx (100%) rename website/docs/{about => project/history}/_common/_history-restructuring.mdx (100%) rename website/docs/{about => project/history}/_common/_history-setup-discontinued.mdx (100%) rename website/docs/{about => project/history}/_common/_history-xbb-v5.mdx (100%) rename website/docs/{about => project/history}/_history.mdx (100%) create mode 100644 website/docs/project/history/index.mdx diff --git a/website/blog/_common/_download-analytics.mdx b/website/blog/_common/_download-analytics.mdx index 71d9056..17e4bc8 100644 --- a/website/blog/_common/_download-analytics.mdx +++ b/website/blog/_common/_download-analytics.mdx @@ -12,8 +12,8 @@ import Image from '@theme/IdealImage'; - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/realpath-xpack/total.svg)](https://github.com/xpack-dev-tools/realpath-xpack/releases) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=realpath-xpack) (grouped by release) - npmjs.com [@xpack-dev-tools/realpath](https://www.npmjs.com/package/@xpack-dev-tools/realpath) - - latest releases [![npm](https://img.shields.io/npm/dw/@xpack-dev-tools/realpath.svg)](https://www.npmjs.com/package/@xpack-dev-tools/realpath/) - - all @xpack-dev-tools releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/realpath.svg)](https://www.npmjs.com/package/@xpack-dev-tools/realpath/) + - last week downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Frealpath)](https://www.npmjs.com/package/@xpack-dev-tools/realpath/) + - total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Frealpath)](https://www.npmjs.com/package/@xpack-dev-tools/realpath/) Credit to [Shields IO](https://shields.io) for the badges and to [Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats) diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index 386dea8..7e91e60 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -57,7 +57,7 @@ platform specific archives. ## Automated install -The easiest (and recommended) way to install GNU realpath +The easiest (and recommended) way to install xPack GNU realpath is via **xpm** and the package available as @xpack-dev-tools/realpath from the [`npmjs.com`](https://www.npmjs.com) registry. @@ -318,7 +318,7 @@ The above `xpm install` command will do the following: xpacks/@xpack-dev-tools/realpath/.content/bin; * add @xpack-dev-tools/realpath to `package.json` as a - development dependency; this associates a specific version of GNU realpath with + development dependency; this associates a specific version of xPack GNU realpath with the current project (details below). :::tip @@ -374,7 +374,7 @@ This is particularly useful for CI/CD environments. ### Install globally For older development environments, -it is also possible to install GNU realpath only globally in +it is also possible to install xPack GNU realpath only globally in the **user global xPacks store**, without any local links/forwarders; it is the developer's responsibility to configure the path to the tools. @@ -396,7 +396,7 @@ install the packages globally will fail with _already installed_.
PATH setup -In order to access the GNU realpath binaries installed in +In order to access the xPack GNU realpath binaries installed in the user global xPacks store, the project build configurations need a PATH adjustment: diff --git a/website/docs/about/_common/_intro-primary.mdx b/website/docs/project/about/_common/_intro-primary.mdx similarity index 100% rename from website/docs/about/_common/_intro-primary.mdx rename to website/docs/project/about/_common/_intro-primary.mdx diff --git a/website/docs/about/_common/_intro-secondary.mdx b/website/docs/project/about/_common/_intro-secondary.mdx similarity index 100% rename from website/docs/about/_common/_intro-secondary.mdx rename to website/docs/project/about/_common/_intro-secondary.mdx diff --git a/website/docs/about/_common/_website-docusaurus-migration.mdx b/website/docs/project/about/_common/_website-docusaurus-migration.mdx similarity index 100% rename from website/docs/about/_common/_website-docusaurus-migration.mdx rename to website/docs/project/about/_common/_website-docusaurus-migration.mdx diff --git a/website/docs/about/_common/_website-docusaurus-template.mdx b/website/docs/project/about/_common/_website-docusaurus-template.mdx similarity index 100% rename from website/docs/about/_common/_website-docusaurus-template.mdx rename to website/docs/project/about/_common/_website-docusaurus-template.mdx diff --git a/website/docs/about/_common/_website-jekyll.mdx b/website/docs/project/about/_common/_website-jekyll.mdx similarity index 100% rename from website/docs/about/_common/_website-jekyll.mdx rename to website/docs/project/about/_common/_website-jekyll.mdx diff --git a/website/docs/about/_more-intro.mdx b/website/docs/project/about/_more-intro.mdx similarity index 100% rename from website/docs/about/_more-intro.mdx rename to website/docs/project/about/_more-intro.mdx diff --git a/website/docs/about/_website.mdx b/website/docs/project/about/_website.mdx similarity index 100% rename from website/docs/about/_website.mdx rename to website/docs/project/about/_website.mdx diff --git a/website/docs/about/index.mdx b/website/docs/project/about/index.mdx similarity index 85% rename from website/docs/about/index.mdx rename to website/docs/project/about/index.mdx index ecc9ce5..4921754 100644 --- a/website/docs/about/index.mdx +++ b/website/docs/project/about/index.mdx @@ -13,13 +13,12 @@ keywords: - web - author -date: 2024-09-22 10:23:00 +0300 +date: 2024-10-24 23:58:00 +0300 --- -import customField from '@site/src/libs/customField'; + import MoreIntro from './_more-intro.mdx' -import History from './_history.mdx' import Website from './_website.mdx' {/* ------------------------------------------------------------------------ */} @@ -28,6 +27,7 @@ import Website from './_website.mdx' ## The project + The **xPack GNU realpath** project is part of the [xPack Reproducible Build Framework](https://xpack.github.io) and is hosted on GitHub as @@ -36,9 +36,11 @@ part of the [xPack Binary Development Tools](https://github.com/xpack-dev-tools/ -## Project history - +## The project history + +The **xPack GNU realpath** history is presented +in a separate [History](/docs/project/history/) page. ## The web site @@ -52,7 +54,8 @@ a senior computer engineer, with expertise in **C++/C embedded systems**, **RTOSes**, **build tools**, operating systems, compilers and Internet technologies. + He can be reached at [``](mailto:ilg@livius.net). Please note, this email address is provided as a courtesy. For all correspondence related to the **xPack GNU realpath** -project, kindly use the project [support](/docs/support/) page). + project, kindly use the project [support](/docs/support/) page). diff --git a/website/docs/about/_common/History32bitDiscontinued/index.tsx b/website/docs/project/history/_common/History32bitDiscontinued/index.tsx similarity index 100% rename from website/docs/about/_common/History32bitDiscontinued/index.tsx rename to website/docs/project/history/_common/History32bitDiscontinued/index.tsx diff --git a/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx b/website/docs/project/history/_common/HistoryAppleSiliconAdded/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx rename to website/docs/project/history/_common/HistoryAppleSiliconAdded/index.tsx diff --git a/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx b/website/docs/project/history/_common/HistoryArmLinuxAdded/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryArmLinuxAdded/index.tsx rename to website/docs/project/history/_common/HistoryArmLinuxAdded/index.tsx diff --git a/website/docs/about/_common/HistoryPlatformsAdded/index.tsx b/website/docs/project/history/_common/HistoryPlatformsAdded/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryPlatformsAdded/index.tsx rename to website/docs/project/history/_common/HistoryPlatformsAdded/index.tsx diff --git a/website/docs/about/_common/HistoryRenameXpack/index.tsx b/website/docs/project/history/_common/HistoryRenameXpack/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryRenameXpack/index.tsx rename to website/docs/project/history/_common/HistoryRenameXpack/index.tsx diff --git a/website/docs/about/_common/HistoryWindowsUcrt/index.tsx b/website/docs/project/history/_common/HistoryWindowsUcrt/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryWindowsUcrt/index.tsx rename to website/docs/project/history/_common/HistoryWindowsUcrt/index.tsx diff --git a/website/docs/about/_common/HistoryXpm/index.tsx b/website/docs/project/history/_common/HistoryXpm/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryXpm/index.tsx rename to website/docs/project/history/_common/HistoryXpm/index.tsx diff --git a/website/docs/about/_common/HistoryZipAdded/index.tsx b/website/docs/project/history/_common/HistoryZipAdded/index.tsx similarity index 100% rename from website/docs/about/_common/HistoryZipAdded/index.tsx rename to website/docs/project/history/_common/HistoryZipAdded/index.tsx diff --git a/website/docs/about/_common/_history-gnu-arm-eclipse.mdx b/website/docs/project/history/_common/_history-gnu-arm-eclipse.mdx similarity index 100% rename from website/docs/about/_common/_history-gnu-arm-eclipse.mdx rename to website/docs/project/history/_common/_history-gnu-arm-eclipse.mdx diff --git a/website/docs/about/_common/_history-rename-xpack.mdx b/website/docs/project/history/_common/_history-rename-xpack.mdx similarity index 100% rename from website/docs/about/_common/_history-rename-xpack.mdx rename to website/docs/project/history/_common/_history-rename-xpack.mdx diff --git a/website/docs/about/_common/_history-restructuring.mdx b/website/docs/project/history/_common/_history-restructuring.mdx similarity index 100% rename from website/docs/about/_common/_history-restructuring.mdx rename to website/docs/project/history/_common/_history-restructuring.mdx diff --git a/website/docs/about/_common/_history-setup-discontinued.mdx b/website/docs/project/history/_common/_history-setup-discontinued.mdx similarity index 100% rename from website/docs/about/_common/_history-setup-discontinued.mdx rename to website/docs/project/history/_common/_history-setup-discontinued.mdx diff --git a/website/docs/about/_common/_history-xbb-v5.mdx b/website/docs/project/history/_common/_history-xbb-v5.mdx similarity index 100% rename from website/docs/about/_common/_history-xbb-v5.mdx rename to website/docs/project/history/_common/_history-xbb-v5.mdx diff --git a/website/docs/about/_history.mdx b/website/docs/project/history/_history.mdx similarity index 100% rename from website/docs/about/_history.mdx rename to website/docs/project/history/_history.mdx diff --git a/website/docs/project/history/index.mdx b/website/docs/project/history/index.mdx new file mode 100644 index 0000000..c72fb33 --- /dev/null +++ b/website/docs/project/history/index.mdx @@ -0,0 +1,20 @@ +--- + +title: History +description: The most important moments since the project was created. +keywords: + - xpack + - realpath + - history + +date: 2024-10-24 23:58:00 +0300 + +--- + +import History from './_history.mdx' + +{/* ------------------------------------------------------------------------ */} + +# The xPack GNU realpath history + + diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx index dfc1cdd..f7a424c 100644 --- a/website/docs/support/index.mdx +++ b/website/docs/support/index.mdx @@ -22,14 +22,26 @@ import Documentation from '../getting-started/_documentation.mdx'; # How to get help for the xPack GNU realpath + ## Quick links The quick answer is to use the -[GitHub Discussions](https://github.com/xpack-dev-tools/realpath-xpack/discussions) pages. +[GitHub Discussions](https://github.com/xpack-dev-tools/realpath-xpack/discussions) +pages. + + +## Web pages issues + +If you find any issues in the content of these pages (such as typos or +incorrect phrasing) or have suggestions for improving the documentation, +please share them through the +[GitHub Discussions](https://github.com/xpack-dev-tools/realpath-xpack/discussions) +pages. + ## Check documentation -As usual, before anything, it is a good idea to check the project +As usual, before asking anything, it is a good idea to check the project documentation. @@ -45,27 +57,31 @@ for similar problems similar topics - check the [GitHub Issues](https://github.com/xpack-dev-tools/realpath-xpack/issues) -tracker for similar problems. +tracker and the +[GitHub Pull Requests](https://github.com/xpack-dev-tools/realpath-xpack/pulls) +for similar problems. ## Ask questions in GitHub Discussions If you still could not find a solution, if you have interesting use cases, if you have custom configurations, and generally if you have -any experience that you want to share with others, use the -[GitHub Discussions](https://github.com/xpack-dev-tools/realpath-xpack/discussions) pages, -and enter a **New discussion**; use the **Q&A** category for questions, **Ideas** for suggestions and **General** for anything else. +any experience that you want to share with others, +use [GitHub Discussions](https://github.com/xpack-dev-tools/realpath-xpack/discussions) +pages. +Enter a **New discussion**; use the **Q&A** category for questions, +**Ideas** for suggestions and **General** for everything else. + ## Register a new support ticket only if necessary -If you are convinced that you identified a bug related to the xPack binary -distribution, not to the upstream GNU realpath itself -(if you have doubts, use the GitHub Discussions), -or if you have a pertinent suggestion how to enhance the **xPack GNU realpath** -distribution, register a **New Issue** in the +If you are convinced that you identified a bug +or if want to contribute code to enhance the +**xPack GNU realpath** +project, register a **New Issue** in the [GitHub Issues](https://github.com/xpack-dev-tools/realpath-xpack/issues) tracker. -:::tip +:::caution **Do not** use the GitHub Issues tracker for questions and support, **use the @@ -73,6 +89,43 @@ for questions and support, **use the ::: + +## Stack Overflow + +For community help, you can also use +[Stack Overflow](https://stackoverflow.com/). +Tag your questions with `xpack`. + +:::tip + +Please be aware that there is another tag `elastic-x-pack` for a different +project, and some of their questions are tagged with `xpack` too. + +::: + +## The Discord channel + +For live discussions among members, join the **xPack Community** on +[Discord](https://discord.com/invite/kbzWaJerFG). + +Currently, there are three channels available: + +- `#xpm` +- `#xcdl` +- `#xpack-dev-tools` +- `#general` + +These channels are open for free discussions on their respective topics. + +However, for support, please use GitHub Discussions whenever possible. + +## X/Twitter + +New releases and other announcements are posted on +[X/Twitter](https://twitter.com/xpack_project). + +Follow the hashtag `#xpack_project` for the latest updates. + ## Use of private e-mail :::caution Please, please, please! diff --git a/website/docusaurus-config-redirects.ts b/website/docusaurus-config-redirects.ts index e902b0b..5313450 100644 --- a/website/docusaurus-config-redirects.ts +++ b/website/docusaurus-config-redirects.ts @@ -25,7 +25,7 @@ export const redirects = { // to: '/docs/newDoc2', // from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'], // }, - + { from: '/docs/developer-info', to: '/docs/developer', @@ -37,7 +37,11 @@ export const redirects = { { from: '/docs/user-info', to: '/docs/user', - } + }, + { + from: '/docs/about', + to: '/docs/project/about', + }, ], createRedirects(existingPath) { console.log(existingPath); @@ -56,7 +60,7 @@ export const redirects = { // } // return undefined; // Return a falsy value: no redirect created // }, - + if (existingPath.includes('/user-info')) { return [ existingPath.replace('/user-info', '/user') @@ -70,5 +74,5 @@ export const redirects = { existingPath.replace('/maintainer-info', '/maintainer') ]; } -} + } } diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 9403a14..213c195 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -188,7 +188,6 @@ const config: Config = { logo: { alt: 'xPack Logo', src: 'img/components-256.png', - // href: 'https://xpack.github.io/', href: 'https://xpack-dev-tools.github.io/' }, items: [ @@ -238,10 +237,11 @@ const config: Config = { }, { label: 'About', - to: '/docs/about' - } + to: '/docs/project/about' + }, ] }, + { type: 'dropdown', to: '/blog', diff --git a/website/package.json b/website/package.json index 6d3baf6..4b7672c 100644 --- a/website/package.json +++ b/website/package.json @@ -44,6 +44,12 @@ "liquidjs": "^10.20.1", "typescript": "~5.2.2" }, + "$devDependenciesUrls": [ + "https://www.npmjs.com/package/del-cli", + "https://www.npmjs.com/package/json", + "https://www.npmjs.com/package/liquidjs", + "https://www.npmjs.com/package/typescript" + ], "browserslist": { "production": [ ">0.5%", diff --git a/website/sidebars.ts b/website/sidebars.ts index b93728a..1fbaa52 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -64,10 +64,31 @@ const sidebars: SidebarsConfig = { label: 'Releases' }, { - type: 'doc', - id: 'about/index', - label: 'About' - } + type: 'category', + label: 'Project', + link: { + type: 'doc', + id: 'project/about/index', + }, + collapsed: false, + items: [ + { + type: 'doc', + id: 'project/about/index', + label: 'About' + }, + { + type: 'doc', + id: 'project/history/index', + label: 'History' + }, + { + type: 'link', + label: 'License', + href: 'https://opensource.org/license/MIT', + }, + ] + }, ], };