litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
litmus-docs/website
History
Vedant Shrotria d77525d990
Added User guides for Observability Setup & Comparative Analysis. (#71) 
* Added user guides for overview, workflow analytics & workflow comparison tabs.

Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com>

* Formatted the assets structure & addressed the changes.

Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com>

* Added the required changes.

Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com>
 		2021-08-03 15:34:29 +05:30
..
build Added a New Version 2.0.0-Beta-1. (#22) 2021-03-16 00:58:57 +05:30
docs Added User guides for Observability Setup & Comparative Analysis. (#71) 2021-08-03 15:34:29 +05:30
src area(Docs WebUI): Updated Web UI with ChaosHub and Tutorials (#69) 2021-07-30 16:40:27 +05:30
static area(Docs WebUI): Updated Web UI with ChaosHub and Tutorials (#69) 2021-07-30 16:40:27 +05:30
versioned_docs type(migration): Adding Litmus Docs 2.0 website with SASS (#46) 2021-06-30 13:14:43 +05:30
versioned_sidebars Adding Version 2.0.0-Beta8 Docs. (#41) 2021-06-16 00:00:04 +05:30
.prettierrc Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
README.md (commands) Added Readme Changes for Versioning command. (#7) 2021-01-13 11:45:56 +05:30
babel.config.js Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
docusaurus.config.js area(Getting-Started): Updated Getting Started Section (#67) 2021-07-29 15:17:45 +05:30
package-lock.json Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
package.json Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
sidebars.js Teaming/user management (#68) 2021-08-02 15:12:34 +05:30
versions.json type(migration): Adding Litmus Docs 2.0 website with SASS (#46) 2021-06-30 13:14:43 +05:30

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.