tarantool / tarantool/doc

Guidelines for reusing/including content

Open
#1,817 2 comments 0 reactions 1 assignee View on GitHub

@NickVolynkin is already working on this.

Since Feb 12, 2021.

guidelines internal
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

How to include/reuse content in the documentation pages:

  • including rST files with include
  • including code examples with literalinclude, setting the correct code highlighing
  • indentation, headings, reference labels
  • put included files in the _includes directory
  • conf.py → exclude_pattern variable
  • rst_prolog, rst_epilog
  • what happens with the localization

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.