CrateDB Documentation System

Build system, authoring, and QA tools, and a style guide for the CrateDB documentation.

🧐 What's Inside

• docs contains an example documentation instance for demonstration purposes.
• style contains the CrateDB style guide.
• The tasks.py file includes tooling to support operations in tech writing.
• The registry folder includes the github-projects.txt and sphinx-inventories.txt files, which enumerate all repositories and target URLs that resemble the documentation at https://cratedb.com/docs/.

Usage

🍀 Tools

A few operational tasks are defined within the top-level tasks.py file. After setup:

git clone https://github.com/crate/crate-docs
cd crate-docs
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

you can display a list of available tasks using:

invoke --list

There is also tooling to support Technical Writing on HubSpot.

🔗 Intersphinx

For displaying intersphinx inventories to learn about available link targets, run commands like this:

invoke inv https://cratedb.com/docs/crate/reference/en/latest/objects.inv
invoke allinv --format=markdown
invoke allinv --format=html+table

Contributing

This project is primarily maintained by Crate.io, but we welcome community contributions!

See the developer docs and contributor docs for more information.

Help

Looking for more help?

• Check out our support channels
• Read our Code of Conduct