Skip to content

update readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jordalgo merged 1 commit into from
Jan 28, 2025
Merged

update readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 2 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,4 @@
# Docs Website

See https://github.com/bpftrace/website for instructions on working with a Docusaurus site.

## Directory Structure

The `docs` directory holds documentation for the in-development, unreleased bpftrace version. It should regularly pull in the docs from the bpftrace source repository.

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.

## Updating Docs

1. Update the versioned documentation snapshots:
```
rm -rf versioned_docs/version-latest
cp -r docs versioned_docs/version-latest
cp -r docs versioned_docs/version-x.y
```

2. Add the new version to `versions.json`, directly underneath `"latest"`.
3. In `docusaurus.config.js`, update the version number in `config.presets.docs.versions` to refer to the new release.
This now just redirects to bpftrace.org and will be deprecated
as soon as we can update the DNS entry for docs.bpftrace.org.
Loading