Skip to content

Commit 4f3cda0

Browse files
committed
website: add developer/install/maintainer/user pages
1 parent d54e403 commit 4f3cda0

File tree

13 files changed

+564
-3
lines changed

13 files changed

+564
-3
lines changed

build-assets/package.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"xpack": {
88
"minimumXpmRequired": "0.16.3",
99
"devDependencies": {
10-
"@xpack-dev-tools/xbb-helper": "^3.0.16"
10+
"@xpack-dev-tools/xbb-helper": "^3.0.17"
1111
},
1212
"properties": {
1313
"appName": "Binary Development Tools",
@@ -16,7 +16,11 @@
1616
"isOrganizationWeb": "true",
1717
"docusaurusTagline": "Cross-platform binary tools for software development, aimed at reproducible builds",
1818
"docusaurusBaseUrl": "/",
19-
"gitHubProjectName": "xpack-dev-tools.github.io"
19+
"gitHubProjectName": "xpack-dev-tools.github.io",
20+
"hasCustomDeveloper": "true",
21+
"hasCustomInstall": "true",
22+
"hasCustomMaintainer": "true",
23+
"hasCustomUser": "true"
2024
},
2125
"xpm-version": "0.18.0",
2226
"xpm-install-loglevel": "info",
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
{/* ------------------------------------------------------------------------ */}
3+
4+
Each project has separate pages designed for developers who plan to
5+
contribute new features or fix bugs, and includes documentation on
6+
how to build and test the package.
7+
8+
Please follow the **Contributor's Guide** menu for each project.
9+
10+
## Prerequisites
11+
12+
The build scripts run on GNU/Linux and macOS.
13+
14+
The detailed steps to install the prerequisites are provided in the
15+
[Build Prerequisites](./install/prerequisites/) page.

website/docs/developer/index.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
3+
# DO NOT EDIT!
4+
# Automatically generated from xbb-helper/templates/docusaurus/common.
5+
6+
title: Contributor's Guide
7+
description: Guidance for developers aiming to contribute new features or bug fixes, detailing how to build the binaries, including prerequisites, repositories utilised, and scripts.
8+
keywords:
9+
- xpack
10+
- xpack-dev-tools.github.io
11+
- prerequisites
12+
- build
13+
14+
date: 2024-07-21 20:33:00 +0300
15+
16+
---
17+
18+
19+
20+
import CustomDeveloper from './_custom-developer.mdx'
21+
22+
{/* ------------------------------------------------------------------------ */}
23+
24+
# Contributor's Guides
25+
26+
<CustomDeveloper />
27+
28+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
3+
### node/npm
4+
5+
`npm` is included with Node.js and is required to install `xpm`.
6+
7+
For full details on installing Node.js, please refer to the
8+
[xPack prerequisites](http://xpack.github.io/install/) page.
9+
10+
:::caution
11+
12+
Ensure you **do not** install npm with administrative rights,
13+
such as via a system package manager. Instead, use `nvm` as
14+
instructed to avoid permission-related issues.
15+
16+
:::
17+
18+
### xpm
19+
20+
[`xpm`](https://xpack.github.io/xpm/) is a portable
21+
[Node.js](https://nodejs.org/) command line application.
22+
23+
If you followed the _Quick instructions_, it is already installed.
24+
25+
Otherwise, to install it, follow the steps in the
26+
[xpm install](http://xpack.github.io/xpm/install/) page.
27+
28+
If you are confident in your knowledge and prefer a shortcut,
29+
issue the following command:"
30+
31+
32+
```sh
33+
npm install --global xpm@latest
34+
```
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
3+
## npm/xpm
4+
5+
### Quick instructions
6+
7+
If you are confident in your knowledge and prefer a shortcut, copy and
8+
paste the following
9+
[script](https://github.com/xpack/assets/blob/master/scripts/install-nvm-node-npm-xpm.sh)
10+
into a terminal (otherwise, perform the steps one by one).
11+
12+
:::caution
13+
14+
For security reasons, conscientious users should first check
15+
the content of the file before executing it.
16+
17+
:::
18+
19+
```sh
20+
mkdir -pv "${HOME}/Downloads/"
21+
curl --output "${HOME}/Downloads/install-nvm-node-npm-xpm.sh" https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh
22+
cat "${HOME}/Downloads/install-nvm-node-npm-xpm.sh"
23+
24+
bash "${HOME}/Downloads/install-nvm-node-npm-xpm.sh"
25+
26+
exit
27+
```
28+
29+
This script will install `nvm` (the Node Version Manager), `node`,
30+
`npm` and `xpm`.
31+
32+
:::info
33+
34+
To activate `nvm` automatically,
35+
the script adds several lines
36+
to the shell initialisation script.
37+
38+
:::

0 commit comments

Comments
 (0)