krill-user-guide

First steps

Local installation

1. Install Node / NPM (Ubuntu installation guide)
2. Install Yarn (Ubuntu installation guide)
3. Install generate-release package (Installation)
4. Install Git flow plugin (Installation)
5. Init flow inside folder: git flow init

Setup repository

1. Inside krill-user-guide folder
2. Change to develop branch: git checkout develop
3. Install dependencies: yarn install

Development server

To run development server:

yarn docs:dev

Deploy changes and sync with guide server

To deploy changes and sync you must commit and push work. Then from root repository folder:

bash scripts/build.sh

Folders structure

• Docs are archived inside /docs/krill2 folder.
• Spanish docs are archived inside /docs/es/krill2 folder.
• Images are stored inside /docs/.vuepress/public/img folder (try to keep organized structure inside it).