https://github.com/crate/crate-docs
Common build system, QA tools, style guides, and other meta miscellanies for doing docs at Crate.io.
https://github.com/crate/crate-docs
build docs qa style-guide
Last synced: about 1 month ago
JSON representation
Common build system, QA tools, style guides, and other meta miscellanies for doing docs at Crate.io.
- Host: GitHub
- URL: https://github.com/crate/crate-docs
- Owner: crate
- License: apache-2.0
- Created: 2020-09-01T08:09:36.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-09-29T18:15:35.000Z (9 months ago)
- Last Synced: 2025-09-29T20:30:54.709Z (9 months ago)
- Topics: build, docs, qa, style-guide
- Language: Shell
- Homepage:
- Size: 780 KB
- Stars: 2
- Watchers: 21
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst
Awesome Lists containing this project
README
============================
CrateDB Documentation System
============================
|version| |ci| |rtd|
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`_
.. |version| image:: https://img.shields.io/endpoint.svg?color=blue&label=docs%20build%20version&url=https://raw.githubusercontent.com/crate/crate-docs/main/docs/build.json
:alt: Build version
:target: https://github.com/crate/crate-docs/blob/main/docs/build.json
.. |ci| image:: https://github.com/crate/crate-docs/workflows/docs/badge.svg
:alt: CI status
:target: https://github.com/crate/crate-docs/actions/workflows/docs.yml
.. |rtd| image:: https://readthedocs.org/projects/crate-docs/badge/?version=latest
:alt: Read The Docs status
:target: https://readthedocs.org/projects/crate-docs
.. _Code of Conduct: CONTRIBUTING.rst
.. _contributor docs: CONTRIBUTING.rst
.. _Crate.io: https://cratedb.com/
.. _CrateDB documentation: https://cratedb.com/docs/
.. _developer docs: DEVELOP.rst
.. _github-projects.txt: registry/github-projects.txt
.. _intersphinx: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _sphinx-inventories.txt: registry/sphinx-inventories.txt
.. _support channels: https://cratedb.com/support/
.. _Technical Writing on HubSpot: https://github.com/crate-workbench/hubspot-tech-writing