Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/litmuschaos/v1-litmus-docs
Documentation for the Litmus Project
https://github.com/litmuschaos/v1-litmus-docs
chaos-engineering documentation embedmd hacktoberfest
Last synced: 4 days ago
JSON representation
Documentation for the Litmus Project
- Host: GitHub
- URL: https://github.com/litmuschaos/v1-litmus-docs
- Owner: litmuschaos
- License: apache-2.0
- Created: 2019-03-08T07:34:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T10:21:39.000Z (3 months ago)
- Last Synced: 2024-08-14T11:58:34.155Z (3 months ago)
- Topics: chaos-engineering, documentation, embedmd, hacktoberfest
- Language: JavaScript
- Homepage: https://docs.litmuschaos.io/
- Size: 37.9 MB
- Stars: 18
- Watchers: 16
- Forks: 69
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Documentation for the Litmus Project
[](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_shield)
[](https://slack.litmuschaos.io)
[](https://hub.docker.com/r/litmuschaos/ansible-runner)
[](https://github.com/litmuschaos/litmus-docs/stargazers)
[](https://github.com/litmuschaos/litmus-docs/issues)
[](https://github.com/litmuschaos/litmus-docs/pulls)
[](https://twitter.com/LitmusChaos)
[](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw)
[](https://github.com/litmuschaos/litmus-docs/pulls)
[](https://github.com/litmuschaos/litmus-docs)
#### *Read this in [other languages](translations/TRANSLATIONS.md).*
[FR](translations/README-fr.md)
Additional details on the Docusaurus project can be found [here](https://docusaurus.io/docs/en/installation.html).
#
## For Developers
### Clone litmus-docs repository
```bash
git clone https://github.com/litmuschaos/litmus-docs.git
cd litmus-docs
```
The docs website server can be setup manually or through docker compose
## Use embedmd command before commiting changes
The embedded code will be extracted from the file at `URL`, which can either be a relative path to a file in the local file system (using forward slashes as directory separator) or a URL starting with `http://` or `https://.`
_Installation:_
- Make sure you have [golang](https://github.com/golang/go) installed. We just need to run the following command to install embedmd.
```bash
go get github.com/campoy/embedmd
```
_Run embedmd (needs to be done before commiting the changes):_
- Follow the steps (from root directory) to run embedmd:
```bash
cd docs
embedmd -w $(find *.md)
```
_Check the difference:_
- Executing `embedmd -d docs-name.md` will display the difference between the contents of docs-name.md and the output of embedmd docs-name.md.
## Manual Setup
### Install Node.js
```bash
sudo apt-get install software-properties-common
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
```
### Get the latest Node.js package
```bash
sudo apt-get install -y nodejs
```
### Install Yarn
```bash
npm install -g yarn
```
### Start the server
```bash
cd website
yarn install
yarn start
```
## Using Docker compose
### Install docker compose
```bash
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
### Run the server
```bash
docker-compose up
```
## Browse local documentation
http://localhost:3000/docs/next/getstarted.html
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_large)