Skip to content

Commit

Permalink
website: re-generate commons
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jan 22, 2025
1 parent b4ea25f commit bdc037a
Show file tree
Hide file tree
Showing 30 changed files with 142 additions and 35 deletions.
4 changes: 2 additions & 2 deletions website/blog/_common/_download-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import Image from '@theme/IdealImage';
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/meson-build-xpack/total.svg)](https://github.com/xpack-dev-tools/meson-build-xpack/releases)
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=meson-build-xpack) (grouped by release)
- npmjs.com [@xpack-dev-tools/meson-build](https://www.npmjs.com/package/@xpack-dev-tools/meson-build)
- latest releases [![npm](https://img.shields.io/npm/dw/@xpack-dev-tools/meson-build.svg)](https://www.npmjs.com/package/@xpack-dev-tools/meson-build/)
- all @xpack-dev-tools releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/meson-build.svg)](https://www.npmjs.com/package/@xpack-dev-tools/meson-build/)
- last week downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Fmeson-build)](https://www.npmjs.com/package/@xpack-dev-tools/meson-build/)
- total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Fmeson-build)](https://www.npmjs.com/package/@xpack-dev-tools/meson-build/)

Credit to [Shields IO](https://shields.io) for the badges and to
[Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats)
Expand Down
8 changes: 4 additions & 4 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ platform specific archives.

## Automated install

The easiest (and recommended) way to install Meson Build
The easiest (and recommended) way to install xPack Meson Build
is via **xpm** and the package available
as <a href={`https://www.npmjs.com/package/@xpack-dev-tools/meson-build`}><code>@xpack-dev-tools/meson-build</code></a> from
the [`npmjs.com`](https://www.npmjs.com) registry.
Expand Down Expand Up @@ -349,7 +349,7 @@ The above `xpm install` command will do the following:
<code>xpacks/@xpack-dev-tools/meson-build/.content/bin</code>;
* add <code>@xpack-dev-tools/meson-build</code> to
`package.json` as a
development dependency; this associates a specific version of Meson Build with
development dependency; this associates a specific version of xPack Meson Build with
the current project (details below).

:::tip
Expand Down Expand Up @@ -405,7 +405,7 @@ This is particularly useful for CI/CD environments.
### Install globally

For older development environments,
it is also possible to install Meson Build only globally in
it is also possible to install xPack Meson Build 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.
Expand All @@ -427,7 +427,7 @@ install the packages globally will fail with _already installed_.
<details>
<summary>PATH setup</summary>

In order to access the Meson Build binaries installed in
In order to access the xPack Meson Build binaries installed in
the user global xPacks store,
the project build configurations need a PATH adjustment:

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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'

{/* ------------------------------------------------------------------------ */}
Expand All @@ -28,6 +27,7 @@ import Website from './_website.mdx'

## The project


The **xPack Meson Build** project is part of the
[xPack Reproducible Build Framework](https://xpack.github.io)
and is hosted on GitHub as
Expand All @@ -36,9 +36,11 @@ part of the [xPack Binary Development Tools](https://github.com/xpack-dev-tools/

<MoreIntro/>

## Project history

<History/>
## The project history

The **xPack Meson Build** history is presented
in a separate [History](/docs/project/history/) page.

## The web site

Expand All @@ -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 [`<[email protected]>`](mailto:[email protected]).
Please note, this email address is provided as a courtesy.
For all correspondence related to the **xPack Meson Build**
project, kindly use the project [support](/docs/support/) page).
project, kindly use the project [support](/docs/support/) page).
File renamed without changes.
20 changes: 20 additions & 0 deletions website/docs/project/history/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---

title: History
description: The most important moments since the project was created.
keywords:
- xpack
- meson-build
- history

date: 2024-10-24 23:58:00 +0300

---

import History from './_history.mdx'

{/* ------------------------------------------------------------------------ */}

# The xPack Meson Build history

<History />
77 changes: 65 additions & 12 deletions website/docs/support/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,26 @@ import Documentation from '../getting-started/_documentation.mdx';

# How to get help for the xPack Meson Build


## Quick links

The quick answer is to use the
[GitHub Discussions](https://github.com/xpack-dev-tools/meson-build-xpack/discussions) pages.
[GitHub Discussions](https://github.com/xpack-dev-tools/meson-build-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/meson-build-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.

<Documentation/>
Expand All @@ -45,34 +57,75 @@ for similar problems
similar topics
- check the
[GitHub Issues](https://github.com/xpack-dev-tools/meson-build-xpack/issues)
tracker for similar problems.
tracker and the
[GitHub Pull Requests](https://github.com/xpack-dev-tools/meson-build-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/meson-build-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/meson-build-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 Meson Build itself
(if you have doubts, use the GitHub Discussions),
or if you have a pertinent suggestion how to enhance the **xPack Meson Build**
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 Meson Build**
project, register a **New Issue** in the
[GitHub Issues](https://github.com/xpack-dev-tools/meson-build-xpack/issues)
tracker.

:::tip
:::caution

**Do not** use the GitHub Issues tracker
for questions and support, **use the
[GitHub Discussions](https://github.com/xpack-dev-tools/meson-build-xpack/discussions)** pages.

:::


## 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!
Expand Down
12 changes: 8 additions & 4 deletions website/docusaurus-config-redirects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const redirects = {
// to: '/docs/newDoc2',
// from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
// },

{
from: '/docs/developer-info',
to: '/docs/developer',
Expand All @@ -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);
Expand All @@ -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')
Expand All @@ -70,5 +74,5 @@ export const redirects = {
existingPath.replace('/maintainer-info', '/maintainer')
];
}
}
}
}
6 changes: 3 additions & 3 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down Expand Up @@ -238,10 +237,11 @@ const config: Config = {
},
{
label: 'About',
to: '/docs/about'
}
to: '/docs/project/about'
},
]
},

{
type: 'dropdown',
to: '/blog',
Expand Down
6 changes: 6 additions & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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%",
Expand Down
29 changes: 25 additions & 4 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
},
]
},
],
};

Expand Down

0 comments on commit bdc037a

Please sign in to comment.