Contributing to the Knowledge Base

Warning

The knowledge base documentation is under construction and as such the contribution process may change in non-trivial ways.

Contributors may create, submit, and publish knowledge base articles (any document under docs/knowledge_base/) without review from a CODEOWNER. Though peer review is always encouraged, in this case, peer review is optional.

To contribute to this knowledge base:

Info

Please consult the general contribution guidelines before following the procedure below.

These instructions assume a title of A meaningful and unique title for illustrative purposes. Replace this with the real title you wish to give to your knowledge base article.

1. Create a branch

   git checkout -b "kba/$(date +%Y-%m-%d-${LOGNAME})"
   

2. Generate a blank knowledge base article (from template):

   ./scripts/create_kba.sh "A meaningful and unique title"
   

3. Fill in the details with your editor or IDE of choice (for example, VSCode):

   Fill out all sections in the template if you can, but it's not mandatory. If a particular section may not be relevant or helpful, feel free to omit it.

   Leave owners blank!

   Please leave the owners field in the document front-matter empty. Otherwise, future pull requests wll require review from CODEOWNERS before you can merge them.

   For VSCode users...

   If you're already using VSCode...

   code -r 'docs/knowledge_base/a_meaningful_and_unique_title/index.md'
   

4. Commit and push your changes

   git add docs/knowledge_base
   git commit -m "New KBA: A meaningful and unique title"
   git push -u origin
   

5. Feel free to merge as soon as automated checks pass.