Skip to content

Commit 9542aec

Browse files
committed
website: updates and final common rework
1 parent bd026f5 commit 9542aec

File tree

8 files changed

+40
-24
lines changed

8 files changed

+40
-24
lines changed

website/docs/getting-started/_common/_license.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## License
77

8-
The original content is released under the
8+
Unless otherwise stated, the original content is released under the terms of the
99
[MIT License](https://opensource.org/license/mit/),
10-
with all rights reserved to
10+
with all rights reserved by
1111
[Liviu Ionescu](https://github.com/ilg-ul).

website/docs/install/index.mdx

+3-4
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@
44
# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
55

66
title: Install Guides
7-
description: Explain the prerequisites, how to perform an automated or manual installation, how to uninstall, and the folder hierarchies.
7+
description: Explain the prerequisites, how to perform an automated installation, how to uninstall.
88
keywords:
99
- xpack
1010
- xpack-dev-tools.github.io
1111
- prerequisites
1212
- automated
1313
- install
14+
- uninstall
1415

15-
date: 2020-08-21 11:09:00 +0300
16+
date: 2024-10-24 23:57:00 +0300
1617

1718
---
1819

1920
import ProjectContent from './_project/_content.mdx';
2021

2122
{/* ------------------------------------------------------------------------ */}
2223

23-
# Install Guides
24-
2524
<ProjectContent />

website/docs/maintainer/index.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ keywords:
1010
- xpack-dev-tools.github.io
1111
- build
1212

13-
date: 2024-07-21 20:11:00 +0300
13+
date: 2024-10-24 23:59:00 +0300
1414

1515
---
1616

1717
import ProjectContent from './_project/_content.mdx';
1818

1919
{/* ------------------------------------------------------------------------ */}
2020

21-
# Maintainer's Guides
22-
2321
<ProjectContent />

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ and Internet technologies.
1414
He can be reached at [`<[email protected]>`](mailto:[email protected]).
1515
Please note, this email address is provided as a courtesy.
1616
For all correspondence related to the
17-
**xPack Binary Development Tools** projects, kindly use the support pages of each individual project).
17+
**xPack Binary Development Tools** projects, kindly use the support pages of each individual project.

website/docs/project/history/_project/_content.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ import HistoryRestructuring from '../_common/_history-restructuring.mdx';
44

55
{/* ------------------------------------------------------------------------ */}
66

7-
The `xpack-dev-tools` GitHub organization, estatblished in **May 2019**,
7+
### May 2019
8+
9+
The `xpack-dev-tools` GitHub organization, established in **May 2019**,
810
hosts the **xPack Binary Development Tools**.
911

1012
However, the initial projects date back several years earlier, originally

website/docs/support/index.mdx

+12-11
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,14 @@ pages for the specific project you're interested in.
3232

3333
## Web pages issues
3434

35-
If you find any issues in the content of these pages (such as typos or
35+
If you encounter any issues in the content of these pages (such as typos or
3636
incorrect phrasing) or have suggestions for improving the documentation,
3737
please share them through the
3838
GitHub Discussions pages. Use the top-level
3939
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
4040
page for issues related to the main xPack Project site, or the individual project's GitHub Discussions pages for specific projects.
41+
Be sure you provide the full URL of the page, clearly identify the
42+
part with the problematic section, and suggest improvements.
4143

4244
## Check documentation
4345

@@ -62,14 +64,14 @@ for similar problems.
6264

6365
## Ask questions in GitHub Discussions
6466

65-
If you still could not find a solution, if you have interesting use
66-
cases, if you have custom configurations, and generally if you have
67-
any experience that you want to share with others,
67+
If you still cannot find a solution, have interesting use cases,
68+
custom configurations, or any experiences you wish to share with
69+
others, please
6870
use the top-level
6971
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
7072
page for questions related to the top xPack Project. For specific projects,
7173
use the individual project's GitHub Discussions pages.
72-
Enter a **New discussion**; use the **Q&A** category for questions,
74+
Start a **New discussion**; use the **Q&A** category for questions,
7375
**Ideas** for suggestions and **General** for everything else.
7476

7577
## Stack Overflow
@@ -113,13 +115,12 @@ Follow the hashtag `#xpack_project` for the latest updates.
113115
:::caution Please, please, please!
114116

115117
**Do not** use
116-
private e-mail for support, **use the
118+
private e-mail for support; instead, **use the
117119
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)** pages.
118120

119121
:::
120122

121-
Sending private messages will be automatically replied with
122-
a short message including a link to this page.
123-
The reason for this rude behaviour is simply an attempt to use
124-
the time more efficiently; since discussions are archived, other people
125-
having similar problems might benefit from the answers.
123+
Private messages will receive an automated reply containing a link
124+
to this page. This approach is not intended to be discourteous, but
125+
rather to optimise time efficiency; as discussions are archived,
126+
others facing similar issues may benefit from the provided answers.
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
import LibrariesAndRpath from '../_common/_libraries-and-rpath.mdx';
5+
6+
import More from '../_project/_more.mdx';
7+
import Versioning from '../_project/_versioning.mdx';
8+
import UseInTesting from '../_project/_use-in-testing.mdx';
9+
10+
{/* ------------------------------------------------------------------------ */}
11+
12+
<More />
13+
14+
<Versioning/>
15+
16+
<LibrariesAndRpath/>
17+
18+
<UseInTesting/>

website/docs/user/index.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,4 @@ import ProjectContent from './_project/_content.mdx';
1919

2020
{/* ------------------------------------------------------------------------ */}
2121

22-
# User's Guides
23-
2422
<ProjectContent />

0 commit comments

Comments
 (0)