You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the home of the [bpftrace docs](https://docs.bpftrace.org)website. The site itself is built using [Docusaurus](https://docusaurus.io/) with the `master` branch hosting the content and the `gh-pages` branch hosting the actual static content that is served through the GitHub pages infrastructure.
3
+
See https://github.com/bpftrace/website for instructions on working with a Docusaurus site.
4
4
5
-
Steps to develop, test and deploy website changes:
The `docs` directory holds documentation for the in-development, unreleased bpftrace version. It should regularly pull in the docs from the bpftrace source repository.
9
8
10
-
- Setup node modules in repo (on first clone):
11
-
- `npm install`
9
+
The `versioned_docs` directory holds snapshots of the docs from each released version. The latest version should be duplicated as both `version-x.y` and `version-latest`, to facilitate permalinks.
12
10
13
-
- Do your changes in your own branch.
11
+
## Updating Docs
14
12
15
-
- Test your changes locally defaults to `localhost:3000`:
16
-
- `npm start`
17
-
18
-
- If everything is OK, push your branch, create a PR and merge to master.
13
+
1. Update the versioned documentation snapshots:
14
+
```
15
+
rm -rf versioned_docs/version-latest
16
+
cp -r docs versioned_docs/version-latest
17
+
cp -r docs versioned_docs/version-x.y
18
+
```
19
19
20
+
2. Add the new version to `versions.json`, directly underneath `"latest"`.
21
+
3. In `docusaurus.config.js`, update the version number in `config.presets.docs.versions` to refer to the new release.
0 commit comments