Skip to main content

CI/CD

Versioning

The site supports multiple versions. To edit the current (unreleased) version, please edit the website/docs/ folder.

Create a new version

To create a new version (such as a version 1.0)

npm run docusaurus docs:version 1.0

The website/docs folder is copied into website/versioned_docs/version-1.0

Your docs now have 2 versions:

  • 1.0 at http://localhost:3000/docs/ for the version 1.0 docs
  • current at http://localhost:3000/docs/next/ for the upcoming, unreleased docs

Update an existing version

It is possible to edit versioned docs in their respective folder:

  • website/versioned_docs/version-1.0/hello.md updates http://localhost:3000/docs/hello
  • website/docs/hello.md updates http://localhost:3000/docs/next/hello

CD

The production site is deployed to adam-rms.com through Cloudflare Workers.

When submitting PRs, a build is generated by Netlify, which provides a demo url to test in a browser