History

Pratik P Borhade cedd1b756c Fixes #126 : Missing links on chaos-workflow page (#127 ) Signed-off-by: Pratik Borhade <pratikborhade302@gmail.com>		2021-10-02 13:49:33 +05:30
..
docs	Fixes #126 : Missing links on chaos-workflow page (#127 )	2021-10-02 13:49:33 +05:30
src	Removed argo-server from components & fixed some urls. (#115 )	2021-08-26 15:29:34 +05:30
static	…
versioned_docs	Add a doc: Install Litmus on KubeSphere (#110 )	2021-09-24 15:58:45 +05:30
versioned_sidebars	Architecture Docs [Chaos Execution Flow and Chaos Observability Flow] (#116 )	2021-09-08 18:19:31 +05:30
.prettierrc	…
README.md	…
babel.config.js	…
docusaurus.config.js	Added trackingID for google analytics. (#114 )	2021-08-24 13:17:12 +05:30
package-lock.json	…
package.json	Added DocSearch Algolia. (#111 )	2021-08-20 13:41:29 +05:30
sidebars.js	Architecture Docs [Chaos Execution Flow and Chaos Observability Flow] (#116 )	2021-09-08 18:19:31 +05:30
versions.json	…

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

npm run docusaurus docs:version <VERSION>

This command will tag a new version from master docs. It will copy the docs/ folder contents into a new versioned_docs/version-<version>/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-<version>-sidebars.json and append the new version number to versions.json.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true 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.