Skip to content

Commit d64e0df

Browse files
authored
Merge pull request #8 from jordalgo/redirects
update readme
2 parents 50fb1dd + 15fe204 commit d64e0df

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

README.md

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

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.
3+
This now just redirects to bpftrace.org and will be deprecated
4+
as soon as we can update the DNS entry for docs.bpftrace.org.

0 commit comments

Comments
 (0)