Skip to content

Commit 8ea9c69

Browse files
committed
website: re-generate commons
1 parent 856769d commit 8ea9c69

31 files changed

+478
-49
lines changed

website/docs/about/_more-intro.mdx

-30
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
{/* ------------------------------------------------------------------------ */}
3+
4+
The **xPack Binary Development Tools** project is part of the
5+
[xPack Reproducible Build Framework](https://xpack.github.io)
6+
and is hosted on GitHub as
7+
[`xpack-dev-tools`](https://github.com/xpack-dev-tools/).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
{/* ------------------------------------------------------------------------ */}
3+

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

+15-4
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,30 @@ 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+
21+
import CustomAbout from './_custom-about.mdx'
22+
2123
import MoreIntro from './_more-intro.mdx'
22-
import History from './_history.mdx'
2324
import Website from './_website.mdx'
2425

2526
{/* ------------------------------------------------------------------------ */}
2627

2728
# About the xPack Binary Development Tools
2829

29-
<MoreIntro/>
30+
## The project
31+
32+
33+
<CustomAbout />
34+
35+
36+
## The project history
37+
38+
The **xPack Binary Development Tools** history is presented
39+
in a separate [History](/docs/project/history/) page.
3040

3141
## The web site
3242

@@ -40,6 +50,7 @@ a senior computer engineer, with expertise in **C++/C embedded systems**,
4050
**RTOSes**, **build tools**, operating systems, compilers
4151
and Internet technologies.
4252

53+
4354
He can be reached at [`<[email protected]>`](mailto:[email protected]).
4455
Please note, this email address is provided as a courtesy.
4556
For all correspondence related to the
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/*
2+
* DO NOT EDIT!
3+
* Automatically generated from docusaurus-template-liquid/templates/docusaurus.
4+
*
5+
* This file is part of the xPack project (http://xpack.github.io).
6+
* Copyright (c) 2024 Liviu Ionescu. All rights reserved.
7+
*
8+
* Permission to use, copy, modify, and/or distribute this software
9+
* for any purpose is hereby granted, under the terms of the MIT license.
10+
*
11+
* If a copy of the license was not distributed with this file, it can
12+
* be obtained from https://opensource.org/licenses/MIT/.
13+
*/
14+
15+
import customField from '@site/src/libs/customField';
16+
17+
export default function HistoryXpm({specifier}): JSX.Element {
18+
return (
19+
<>The xPack metadata has been added, and the package can now be more conveniently installed via <b>xpm</b>. It is available from <code>npmjs.com</code> as <code>{specifier ? specifier : 'xpack-dev-tools.github.io'}</code></>
20+
);
21+
}

website/docs/about/_history.mdx renamed to website/docs/project/history/_history.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
The project was created in **DATE**.
55

66
The first **xPack Binary Development Tools** release was
7-
[v...](URL),
7+
...,
88
in **DATE**.
+20
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+
- xpack-dev-tools.github.io
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 Binary Development Tools history
19+
20+
<History />

website/docs/support/index.mdx

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
3+
# DO NOT EDIT!
4+
# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
5+
6+
title: Help Centre
7+
description: The project's support channel, where you can ask questions, start discussions, and report issues.
8+
keywords:
9+
- xpack
10+
- xpack-dev-tools.github.io
11+
- support
12+
- discussions
13+
- issues
14+
15+
date: 2020-07-21 17:54:00 +0300
16+
17+
---
18+
19+
import Documentation from '../getting-started/_documentation.mdx';
20+
21+
{/* ------------------------------------------------------------------------ */}
22+
23+
# How to get help for the xPack Binary Development Tools
24+
25+
26+
## Quick tips
27+
28+
The **Binary Development Tools** consists of multiple individual
29+
projects, each hosted on its own GitHub repository. Therefore, the best
30+
way to get answers quickly is to use the
31+
GitHub Discussions
32+
pages for the specific project you're interested in.
33+
34+
35+
## Web pages issues
36+
37+
If you find any issues in the content of these pages (such as typos or
38+
incorrect phrasing) or have suggestions for improving the documentation,
39+
please share them through the
40+
GitHub Discussions pages. Use the top-level
41+
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
42+
page for issues related to the main xPack Project site, or the individual project’s GitHub Discussions pages for specific projects.
43+
44+
## Check documentation
45+
46+
As usual, before asking anything, it is a good idea to check the project
47+
documentation.
48+
49+
<Documentation/>
50+
51+
## Preliminary checks
52+
53+
Before posting any questions or providing feedback,
54+
check if the subject was not already addressed.
55+
56+
- check the FAQ
57+
for similar problems
58+
- check the GitHub Discussions for
59+
similar topics
60+
- check the
61+
GitHub Issues
62+
tracker and the
63+
GitHub Pull Requests
64+
for similar problems.
65+
66+
## Ask questions in GitHub Discussions
67+
68+
If you still could not find a solution, if you have interesting use
69+
cases, if you have custom configurations, and generally if you have
70+
any experience that you want to share with others,
71+
use the top-level
72+
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
73+
page for questions related to the top xPack Project. For specific projects,
74+
use the individual project's GitHub Discussions pages.
75+
Enter a **New discussion**; use the **Q&A** category for questions,
76+
**Ideas** for suggestions and **General** for everything else.
77+
78+
79+
80+
## Stack Overflow
81+
82+
For community help, you can also use
83+
[Stack Overflow](https://stackoverflow.com/).
84+
Tag your questions with `xpack`.
85+
86+
:::tip
87+
88+
Please be aware that there is another tag `elastic-x-pack` for a different
89+
project, and some of their questions are tagged with `xpack` too.
90+
91+
:::
92+
93+
## The Discord channel
94+
95+
For live discussions among members, join the **xPack Community** on
96+
[Discord](https://discord.com/invite/kbzWaJerFG).
97+
98+
Currently, there are three channels available:
99+
100+
- `#xpm`
101+
- `#xcdl`
102+
- `#xpack-dev-tools`
103+
- `#general`
104+
105+
These channels are open for free discussions on their respective topics.
106+
107+
However, for support, please use GitHub Discussions whenever possible.
108+
109+
## X/Twitter
110+
111+
New releases and other announcements are posted on
112+
[X/Twitter](https://twitter.com/xpack_project).
113+
114+
Follow the hashtag `#xpack_project` for the latest updates.
115+
116+
## Use of private e-mail
117+
118+
:::caution Please, please, please!
119+
120+
**Do not** use
121+
private e-mail for support, **use the
122+
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)** pages.
123+
124+
:::
125+
126+
Sending private messages will be automatically replied with
127+
a short message including a link to this page.
128+
The reason for this rude behaviour is simply an attempt to use
129+
the time more efficiently; since discussions are archived, other people
130+
having similar problems might benefit from the answers.
131+

0 commit comments

Comments
 (0)