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
All this site does is redirect to bptrace.org until we update the
4
-
DNS entry for docs.bpftrace.org to point to https://bpftrace.org/docs
3
+
See https://github.com/bpftrace/website for instructions on working with a Docusaurus site.
4
+
5
+
## Directory Structure
6
+
7
+
The `docs` directory holds documentation for the in-development, unreleased bpftrace version. It should regularly pull in the docs from the bpftrace source repository.
8
+
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.
10
+
11
+
## Updating Docs
12
+
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
+
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