4af220ea9d
Update dev and architecture sections |
||
|---|---|---|
| .github/workflows | ||
| blog | ||
| docs | ||
| hack | ||
| src | ||
| static | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| CNAME | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| sidebars.js | ||
| versions.json | ||
| yarn.lock | ||
README.md
Rancher Turtles Documentation
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Versioning
This project follows docusaurus versioning guidelines, including the process of archiving the old versions.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.