scylladb

mirrors/scylladb

Fork 0

Commit Graph

Author	SHA1	Message	Date
Kefu Chai	53dfb5661d	docs: parse source files right into rst so we can render the rst without writing a temporary YAML. Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>	2023-11-04 00:22:33 +08:00
Anna Stuchlik	e223624e2e	doc: fix the Reference page layout This commit fixes the layout of the Reference page. Previously, the toctree level was "2", which made the page hard to navigate. This PR changes the level to "1". In addition, the capitalization of page titles is fixed. This is a follow-up PR to the ones that created and updated the Reference section. It must be backported to branch-5.4. Closes scylladb/scylladb#15830	2023-10-25 12:15:27 +03:00
David Garcia	a14bcf7c6a	docs: improve configuration properties reference - Adds type for each option. - Filters out unused / invalid values, moves them to a separate section. - Adds the term "liveness" to the glossary. - Removes unused and invalid properties from the docs. - Updates to the latest version of pyaml. docs: rename config template directive Closes #15164	2023-09-11 09:47:16 +03:00

Author

SHA1

Message

Date

Kefu Chai

53dfb5661d

docs: parse source files right into rst

so we can render the rst without writing a temporary YAML.

Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>

2023-11-04 00:22:33 +08:00

Anna Stuchlik

e223624e2e

doc: fix the Reference page layout

This commit fixes the layout of the Reference
page. Previously, the toctree level was "2",
which made the page hard to navigate.
This PR changes the level to "1".

In addition, the capitalization of page
titles is fixed.

This is a follow-up PR to the ones that
created and updated the Reference section.
It must be backported to branch-5.4.

Closes scylladb/scylladb#15830

2023-10-25 12:15:27 +03:00

David Garcia

a14bcf7c6a

docs: improve configuration properties reference

- Adds type for each option.
- Filters out unused / invalid values, moves them to a separate section.
- Adds the term "liveness" to the glossary.
- Removes unused and invalid properties from the docs.
- Updates to the latest version of pyaml.

docs: rename config template directive

Closes #15164

2023-09-11 09:47:16 +03:00

3 Commits