This website is built using Docusaurus 2, a modern static website generator. You can view live website here: https://substratus.ai
yarnyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
A lot of the documents on this website are generated from Jupyter Notebooks. This allows for testing documentation.
To edit the notebook files, you can either start a notebook (see below) or use VSCode which can edit notebooks directly.
npm run notebookConvert the notebook files to markdown.
npm run convert-notebooksYou can clear notebook outputs:
npm run clear-notebooksyarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
USE_SSH=true yarn deployNot using SSH:
GIT_USER=<Your GitHub username> yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Source: https://favicon.io/favicon-generator/
See: ./scratch/favicon_io/
Settings:
- Letter: "S" (capital)
- Font: Saira Stencil One
Source: https://fonts.google.com/icons
Settings:
- Weight: 100 (min)
- Grade: 0 (middle)
- Optical Size: 48 (max)
We test the contents of our docs via testbook
and pytest. These tests stand up live cloud infrastructure in our integration
test project or PROJECT_ID if specified instead. The test suite relies on an
active set of GCP credentials in your shell session so
gcloud auth login --update-adc prior to running. The currently set PROJECT_ID
or gcloud-configured project will be used as the target for creating infra.
Tests can be run via:
make testOptionally, you can specify a remote branch of the substratusai/substratus
repo to test against for all manifests referencing examples in that repo.
make test SUBSTRATUS_BRANCH=feat/foobar