2a0bccb653
This moves templating docs to their own section to make it more readable and easier to reference, and adds information about how to escape templating in `fleet.yaml`. |
||
|---|---|---|
| .github/workflows | ||
| docs | ||
| src | ||
| static | ||
| updatecli/updatecli.d | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| CODEOWNERS | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| sidebars.js | ||
| versions.json | ||
| yarn.lock | ||
README.md
Website
This website is built using Docusaurus 2, a modern static website generator.
The docs are hosted at: https://fleet.rancher.io/
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.
Create new versioned docs reference
$ yarn run docusaurus docs:version <NEW_VERSION>
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.