Kraken website and documentation are kept in separate repository: https://github.com/Kraken-CI/website.
Reporting Problems and Enhancements Proposals
If you find any problem in the website or in the documentation, or there is missing anything then please go to issue tracker on GitHub and look around if the problem is already reported and if no then create a new issue (problem or an improvement request).
Preparing Website and Docs Changes
Kraken website and documentation are built using Docusaurus 2, a modern static website generator.
Setting up Environment
Docusaurus web page
advices to install and use
yarn. There is a defect that on some
yarn may hang during package resolve or
fetch. Therefore it is recommended to not install
yarn and use only
npm. All commands below use
npm instead of
yarn. However, if you
have succesfully installed
yarn, you can use it instead of
with the same command syntax.
Step 1: Install npm
Follow your operating system's method to install
npm, for example for Ubuntu:
$ sudo apt install npm
Step 2: Clone reposirory
Fork repository and clony your own copy::
$ git clone [email protected]:<username>/website.git
Step 3: Install Docusaurus dependencies
kraken.ci website repository and execute
npm install command, for example:
$ cd website
$ npm install
It has been observed that
npm may have problems with installing dependencies on Ubuntu 18.04 - upgrading to Ubuntu 20.04 resolves this issue.
$ npm start
This command starts a local development server and open up a browser window. Most changes to the website are reflected live without having to restart the server.
$ npm run build
This command generates static content into the
build directory. This directory can be served using any static contents hosting service.
When you have your changes ready then follow these steps.
- Push your changes to your repository.
- Submit a pull request, referencing any issues it addresses.
We will review your pull request as soon as possible. Thank you for contributing!