Website

This is the home of the bpftrace website. The site itself is built using Docusaurus with the master branch hosting the content which is automatically built and served through the GitHub pages infrastructure.

Development

• Clone the website repo:

  • git clone [email protected]:bpftrace/website.git

• Setup node modules in repo (on first clone):

  • npm install

• Do your changes in your own branch.

• Test your changes locally defaults to localhost:3000:

  • npm start

• If everything is OK, push your branch, create a PR and merge to master.

Resources

• Infima is used for styling and components in docusaurus
• Docusaurus Configuration

Staging

A staging website exists at https://staging.bpftrace.org/ to optionally validate changes before deploying them to the main website.

This staging website is hosted in a fork: https://github.com/bpftrace/website-staging/. When manually interacting with this repository, please ensure that the CNAME and robots.txt changes remain in place.

The easiest way to deploy changes to the staging site is to use the GitHub comment command /stage:

1. Create a PR against the main website repository, as normal
2. Create a comment containing just the text /stage

Updating the Docs

$ git clone https://github.com/bpftrace/bpftrace.git
$ npm make-docs

Updating the Docs for a New Release

To update for a specific release version (e.g. 0.24):

$ git clone https://github.com/bpftrace/bpftrace.git
$ cd bpftrace
$ git fetch origin release/0.24.x
$ git checkout release/0.24.x
$ cd ..
$ npm run make-docs 0.24
$ cp docs/pre-release/docs.js release_024/

You will also need to update the links and text in the copied docs.js file.

Next:

1. update the docusaurus.config.js navigation bar links to include the new release docs
2. remove the "latest" text from the previous release docs.js and update the button dropdown to add the the new release docs to the list
3. update the button dropdown to add the the new release docs to the list in the pre-release/docs.js file