Skip to content

Commit fbfbc1e

Browse files
committed
website: re-generate commons
1 parent 671f934 commit fbfbc1e

30 files changed

+142
-35
lines changed

website/blog/_common/_download-analytics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import Image from '@theme/IdealImage';
1212
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/sed-xpack/total.svg)](https://github.com/xpack-dev-tools/sed-xpack/releases)
1313
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=sed-xpack) (grouped by release)
1414
- npmjs.com [@xpack-dev-tools/sed](https://www.npmjs.com/package/@xpack-dev-tools/sed)
15-
- latest releases [![npm](https://img.shields.io/npm/dw/@xpack-dev-tools/sed.svg)](https://www.npmjs.com/package/@xpack-dev-tools/sed/)
16-
- all @xpack-dev-tools releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/sed.svg)](https://www.npmjs.com/package/@xpack-dev-tools/sed/)
15+
- last week downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Fsed)](https://www.npmjs.com/package/@xpack-dev-tools/sed/)
16+
- total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Fsed)](https://www.npmjs.com/package/@xpack-dev-tools/sed/)
1717

1818
Credit to [Shields IO](https://shields.io) for the badges and to
1919
[Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats)

website/docs/install/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ platform specific archives.
5757

5858
## Automated install
5959

60-
The easiest (and recommended) way to install GNU sed
60+
The easiest (and recommended) way to install xPack GNU sed
6161
is via **xpm** and the package available
6262
as <a href={`https://www.npmjs.com/package/@xpack-dev-tools/sed`}><code>@xpack-dev-tools/sed</code></a> from
6363
the [`npmjs.com`](https://www.npmjs.com) registry.
@@ -318,7 +318,7 @@ The above `xpm install` command will do the following:
318318
<code>xpacks/@xpack-dev-tools/sed/.content/bin</code>;
319319
* add <code>@xpack-dev-tools/sed</code> to
320320
`package.json` as a
321-
development dependency; this associates a specific version of GNU sed with
321+
development dependency; this associates a specific version of xPack GNU sed with
322322
the current project (details below).
323323

324324
:::tip
@@ -374,7 +374,7 @@ This is particularly useful for CI/CD environments.
374374
### Install globally
375375

376376
For older development environments,
377-
it is also possible to install GNU sed only globally in
377+
it is also possible to install xPack GNU sed only globally in
378378
the **user global xPacks store**, without any
379379
local links/forwarders; it
380380
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_.
396396
<details>
397397
<summary>PATH setup</summary>
398398

399-
In order to access the GNU sed binaries installed in
399+
In order to access the xPack GNU sed binaries installed in
400400
the user global xPacks store,
401401
the project build configurations need a PATH adjustment:
402402

website/docs/about/index.mdx renamed to website/docs/project/about/index.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,12 @@ keywords:
1313
- web
1414
- author
1515

16-
date: 2024-09-22 10:23:00 +0300
16+
date: 2024-10-24 23:58:00 +0300
1717

1818
---
1919

20-
import customField from '@site/src/libs/customField';
20+
2121
import MoreIntro from './_more-intro.mdx'
22-
import History from './_history.mdx'
2322
import Website from './_website.mdx'
2423

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

2928
## The project
3029

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

3737
<MoreIntro/>
3838

39-
## Project history
4039

41-
<History/>
40+
## The project history
41+
42+
The **xPack GNU sed** history is presented
43+
in a separate [History](/docs/project/history/) page.
4244

4345
## The web site
4446

@@ -52,7 +54,8 @@ a senior computer engineer, with expertise in **C++/C embedded systems**,
5254
**RTOSes**, **build tools**, operating systems, compilers
5355
and Internet technologies.
5456

57+
5558
He can be reached at [`<ilg@livius.net>`](mailto:ilg@livius.net).
5659
Please note, this email address is provided as a courtesy.
5760
For all correspondence related to the **xPack GNU sed**
58-
project, kindly use the project [support](/docs/support/) page).
61+
project, kindly use the project [support](/docs/support/) page).
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
3+
title: History
4+
description: The most important moments since the project was created.
5+
keywords:
6+
- xpack
7+
- sed
8+
- history
9+
10+
date: 2024-10-24 23:58:00 +0300
11+
12+
---
13+
14+
import History from './_history.mdx'
15+
16+
{/* ------------------------------------------------------------------------ */}
17+
18+
# The xPack GNU sed history
19+
20+
<History />

website/docs/support/index.mdx

Lines changed: 65 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,26 @@ import Documentation from '../getting-started/_documentation.mdx';
2222

2323
# How to get help for the xPack GNU sed
2424

25+
2526
## Quick links
2627

2728
The quick answer is to use the
28-
[GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions) pages.
29+
[GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions)
30+
pages.
31+
32+
33+
## Web pages issues
34+
35+
If you find any issues in the content of these pages (such as typos or
36+
incorrect phrasing) or have suggestions for improving the documentation,
37+
please share them through the
38+
[GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions)
39+
pages.
40+
2941

3042
## Check documentation
3143

32-
As usual, before anything, it is a good idea to check the project
44+
As usual, before asking anything, it is a good idea to check the project
3345
documentation.
3446

3547
<Documentation/>
@@ -45,34 +57,75 @@ for similar problems
4557
similar topics
4658
- check the
4759
[GitHub Issues](https://github.com/xpack-dev-tools/sed-xpack/issues)
48-
tracker for similar problems.
60+
tracker and the
61+
[GitHub Pull Requests](https://github.com/xpack-dev-tools/sed-xpack/pulls)
62+
for similar problems.
4963

5064
## Ask questions in GitHub Discussions
5165

5266
If you still could not find a solution, if you have interesting use
5367
cases, if you have custom configurations, and generally if you have
54-
any experience that you want to share with others, use the
55-
[GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions) pages,
56-
and enter a **New discussion**; use the **Q&A** category for questions, **Ideas** for suggestions and **General** for anything else.
68+
any experience that you want to share with others,
69+
use [GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions)
70+
pages.
71+
Enter a **New discussion**; use the **Q&A** category for questions,
72+
**Ideas** for suggestions and **General** for everything else.
73+
5774

5875
## Register a new support ticket only if necessary
5976

60-
If you are convinced that you identified a bug related to the xPack binary
61-
distribution, not to the upstream GNU sed itself
62-
(if you have doubts, use the GitHub Discussions),
63-
or if you have a pertinent suggestion how to enhance the **xPack GNU sed**
64-
distribution, register a **New Issue** in the
77+
If you are convinced that you identified a bug
78+
or if want to contribute code to enhance the
79+
**xPack GNU sed**
80+
project, register a **New Issue** in the
6581
[GitHub Issues](https://github.com/xpack-dev-tools/sed-xpack/issues)
6682
tracker.
6783

68-
:::tip
84+
:::caution
6985

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

7490
:::
7591

92+
93+
## Stack Overflow
94+
95+
For community help, you can also use
96+
[Stack Overflow](https://stackoverflow.com/).
97+
Tag your questions with `xpack`.
98+
99+
:::tip
100+
101+
Please be aware that there is another tag `elastic-x-pack` for a different
102+
project, and some of their questions are tagged with `xpack` too.
103+
104+
:::
105+
106+
## The Discord channel
107+
108+
For live discussions among members, join the **xPack Community** on
109+
[Discord](https://discord.com/invite/kbzWaJerFG).
110+
111+
Currently, there are three channels available:
112+
113+
- `#xpm`
114+
- `#xcdl`
115+
- `#xpack-dev-tools`
116+
- `#general`
117+
118+
These channels are open for free discussions on their respective topics.
119+
120+
However, for support, please use GitHub Discussions whenever possible.
121+
122+
## X/Twitter
123+
124+
New releases and other announcements are posted on
125+
[X/Twitter](https://twitter.com/xpack_project).
126+
127+
Follow the hashtag `#xpack_project` for the latest updates.
128+
76129
## Use of private e-mail
77130

78131
:::caution Please, please, please!

website/docusaurus-config-redirects.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const redirects = {
2525
// to: '/docs/newDoc2',
2626
// from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
2727
// },
28-
28+
2929
{
3030
from: '/docs/developer-info',
3131
to: '/docs/developer',
@@ -37,7 +37,11 @@ export const redirects = {
3737
{
3838
from: '/docs/user-info',
3939
to: '/docs/user',
40-
}
40+
},
41+
{
42+
from: '/docs/about',
43+
to: '/docs/project/about',
44+
},
4145
],
4246
createRedirects(existingPath) {
4347
console.log(existingPath);
@@ -56,7 +60,7 @@ export const redirects = {
5660
// }
5761
// return undefined; // Return a falsy value: no redirect created
5862
// },
59-
63+
6064
if (existingPath.includes('/user-info')) {
6165
return [
6266
existingPath.replace('/user-info', '/user')
@@ -70,5 +74,5 @@ export const redirects = {
7074
existingPath.replace('/maintainer-info', '/maintainer')
7175
];
7276
}
73-
}
77+
}
7478
}

website/docusaurus.config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,6 @@ const config: Config = {
188188
logo: {
189189
alt: 'xPack Logo',
190190
src: 'img/components-256.png',
191-
// href: 'https://xpack.github.io/',
192191
href: 'https://xpack-dev-tools.github.io/'
193192
},
194193
items: [
@@ -238,10 +237,11 @@ const config: Config = {
238237
},
239238
{
240239
label: 'About',
241-
to: '/docs/about'
242-
}
240+
to: '/docs/project/about'
241+
},
243242
]
244243
},
244+
245245
{
246246
type: 'dropdown',
247247
to: '/blog',

website/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@
4444
"liquidjs": "^10.20.1",
4545
"typescript": "~5.2.2"
4646
},
47+
"$devDependenciesUrls": [
48+
"https://www.npmjs.com/package/del-cli",
49+
"https://www.npmjs.com/package/json",
50+
"https://www.npmjs.com/package/liquidjs",
51+
"https://www.npmjs.com/package/typescript"
52+
],
4753
"browserslist": {
4854
"production": [
4955
">0.5%",

website/sidebars.ts

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,31 @@ const sidebars: SidebarsConfig = {
6464
label: 'Releases'
6565
},
6666
{
67-
type: 'doc',
68-
id: 'about/index',
69-
label: 'About'
70-
}
67+
type: 'category',
68+
label: 'Project',
69+
link: {
70+
type: 'doc',
71+
id: 'project/about/index',
72+
},
73+
collapsed: false,
74+
items: [
75+
{
76+
type: 'doc',
77+
id: 'project/about/index',
78+
label: 'About'
79+
},
80+
{
81+
type: 'doc',
82+
id: 'project/history/index',
83+
label: 'History'
84+
},
85+
{
86+
type: 'link',
87+
label: 'License',
88+
href: 'https://opensource.org/license/MIT',
89+
},
90+
]
91+
},
7192
],
7293
};
7394

0 commit comments

Comments
 (0)