Skip to content

Commit d47fe22

Browse files
committed
README: Add instructions for updating docs
1 parent 73598c9 commit d47fe22

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# Docs Website
22

3-
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.
44

5-
Steps to develop, test and deploy website changes:
5+
## Directory Structure
66

7-
- Clone the website repo:
8-
- `git clone git@github.com:bpftrace/docs-website.git`
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.
98

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.
1210

13-
- Do your changes in your own branch.
11+
## Updating Docs
1412

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+
```
1919

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

Comments
 (0)