Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.68 KB

Contributing

It is simple to get started and contribute to the new documentation on code.kx.com.

In the case of small typos you can simply fork the repository, or click edit button on GitHub, which will automatically fork the repository to your account. Make a change and create a pull request for the main repository. One of the admins will review your change and provide feedback on possible improvements – or just merge it in.

For larger changes it is worth considering establishing a local development setup before creating your pull request. Many users rely on code.kx.com for their daily work and you would not want to see some half-baked pages merged in.

You can either:

  • Install and run mkdocs locally
  • Run a prebuilt docker container with all the development dependencies already installed

Install mkdocs locally

Install the MkDocs package using your packaging tool of choice:

brew install mkdocs # for macOS
sudo apt install mkdocs # Ubuntu
sudo yum install mkdocs # CentOS/RHEL

There are some additional packages and fonts required:

pip install mkdocs-material
pip install fontawesome_markdown

Run your development server:

mkdocs serve

This will start a web server on http://localhost:8000 where you could see the entire website – with hot-reload when you save a change.

Docker

If you have Docker installed you can alternatively run:

./docker_docs.sh serve

This will start a web server in the docker container, where you can preview changes, the site can be accesses at http://localhost:9000.

N.B. build instructions for the image are available