Skip to content

Commit 193ac66

Browse files
ilg-ulilg-ul
committed
website: updates and final common rework
1 parent a268f5e commit 193ac66

File tree

9 files changed

+84
-34
lines changed

9 files changed

+84
-34
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/_project/_content.mdx

+3-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ import customField from '@site/src/libs/customField';
44

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

7-
The production XBB consists of multiple Docker images,
8-
for x64 and arm.
7+
The production XBB comprises multiple Docker images for x64 and Arm.
98

10-
The images are published on
11-
[Docker Hub](https://hub.docker.com/repository/docker/ilegeul/ubuntu)
12-
(pulling can be done anonymously, pushing requires login).
9+
These images are published on [Docker Hub](https://hub.docker.com/repository/docker/ilegeul/ubuntu);
10+
pulling can be done anonymously, while pushing requires login.
1311

1412
x64 image:
1513

‎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 Guide
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
- xbb
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 Guide
24-
2524
<ProjectContent />

‎website/docs/maintainer/index.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ keywords:
1010
- xbb
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 Guide
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 **xPack Build Box**
17-
project, kindly use the project [support](/docs/support/) page).
17+
project, kindly use the project [support](/docs/support/) page.

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

+39-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,42 @@
11

22
{/* ------------------------------------------------------------------------ */}
33

4-
TODO
4+
The project was initiated in **January 2018** to address the need for a build environment capable of integrating `arm-none-eabi-gcc` into **GNU ARM Eclipse**.
5+
6+
7+
The initial release, version **1**, drew inspiration from
8+
[Holy Build Box](https://phusion.github.io/holy-build-box/). It utilised
9+
CentOS 6 Docker images for GNU/Linux and Homebrew for macOS
10+
11+
## March 2019
12+
13+
In March 2019, version **2** was released, incorporating a major rework
14+
15+
## January 2020
16+
17+
In January 2020, version **3** introduced an upgrade to Ubuntu 12
18+
for x64 and Ubuntu 16 for Arm.
19+
20+
The build process was divided into two steps, starting with a bootstrap phase that included essential tools required to build the final tools.
21+
22+
## January 2023
23+
24+
The complexity of the custom builds increased to the point where the entire project became difficult to manage, taking days to complete.
25+
26+
The solution was to migrate all tools to binary xPacks. This was accomplished
27+
in two steps. In the intermediate version **4**, all tools were packaged as
28+
binary xPacks, known as the
29+
[The xPack XBB Bootstrap](https://github.com/xpack-dev-tools/xbb-bootstrap-xpack). The base XBB environment was simplified to standard Docker images or
30+
macOS systems.
31+
32+
The next step, version **5**, upgraded the environment to Ubuntu 18
33+
34+
The v5.0.0 release represents a **major milestone**
35+
for the xPack project, since it is the **first self-sustained** release,
36+
which allows to build new binary xPacks using previous xPacks,
37+
without requiring any custom Docker images, or other compiled tools.
38+
39+
## The foreseeable future
40+
41+
The next step is planned for 2025, featuring an upgrade to Debian 10 and the deprecation of Arm 32-bit support.
42+

‎website/docs/support/index.mdx

+17-16
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ pages.
3030

3131
## Web pages issues
3232

33-
If you find any issues in the content of these pages (such as typos or
33+
If you encounter any issues in the content of these pages (such as typos or
3434
incorrect phrasing) or have suggestions for improving the documentation,
3535
please share them through the
3636
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-build-box/discussions)
3737
pages.
38+
Be sure you provide the full URL of the page, clearly identify the
39+
part with the problematic section, and suggest improvements.
3840

3941
## Check documentation
4042

@@ -59,27 +61,27 @@ for similar problems.
5961

6062
## Ask questions in GitHub Discussions
6163

62-
If you still could not find a solution, if you have interesting use
63-
cases, if you have custom configurations, and generally if you have
64-
any experience that you want to share with others,
65-
use [GitHub Discussions](https://github.com/xpack-dev-tools/xpack-build-box/discussions)
64+
If you still cannot find a solution, have interesting use cases,
65+
custom configurations, or any experiences you wish to share with
66+
others, please
67+
use the [GitHub Discussions](https://github.com/xpack-dev-tools/xpack-build-box/discussions)
6668
pages.
67-
Enter a **New discussion**; use the **Q&A** category for questions,
69+
Start a **New discussion**; use the **Q&A** category for questions,
6870
**Ideas** for suggestions and **General** for everything else.
6971

7072
## Register a new support ticket only if necessary
7173

72-
If you are convinced that you identified a bug
73-
or if want to contribute code to enhance the
74+
If you are convinced that you have identified a bug
75+
or wish to contribute code to enhance the
7476
**xPack Build Box**
7577
project, register a **New Issue** in the
7678
[GitHub Issues](https://github.com/xpack-dev-tools/xpack-build-box/issues)
7779
tracker.
7880

7981
:::caution
8082

81-
**Do not** use the GitHub Issues tracker
82-
for questions and support, **use the
83+
Please **do not** use the GitHub Issues tracker
84+
for questions and support; instead, **use the
8385
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-build-box/discussions)** pages.
8486

8587
:::
@@ -125,13 +127,12 @@ Follow the hashtag `#xpack_project` for the latest updates.
125127
:::caution Please, please, please!
126128

127129
**Do not** use
128-
private e-mail for support, **use the
130+
private e-mail for support; instead, **use the
129131
[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-build-box/discussions)** pages.
130132

131133
:::
132134

133-
Sending private messages will be automatically replied with
134-
a short message including a link to this page.
135-
The reason for this rude behaviour is simply an attempt to use
136-
the time more efficiently; since discussions are archived, other people
137-
having similar problems might benefit from the answers.
135+
Private messages will receive an automated reply containing a link
136+
to this page. This approach is not intended to be discourteous, but
137+
rather to optimise time efficiency; as discussions are archived,
138+
others facing similar issues may benefit from the provided answers.

‎website/docs/user/_common/_content.mdx

+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 Guide
23-
2422
<ProjectContent />

0 commit comments

Comments
 (0)