Commit Graph
5 Commits
Author SHA1 Message Date
Travis Nielsen b665d7a7b7 core: remove support for ceph quincy
Given that Ceph Quincy (v17) is past end of life,
remove Quincy from the supported Ceph versions,
examples, and documentation.

Supported versions now include only Reef and Squid.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-10-03 11:12:55 -06:00
Blaine Gardner c9d99e01a0 ci: use markdownlint to enforce mkdocs compatibility
mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.

As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.

markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:

- all doc lines (except code blocks) must be aligned to a 4-space
  boundary, without exception. This ensures that markdown will render
  correctly with mkdocs. This unfortunately makes it possible to create
  lists that are internally aligned strangely.
- admonitions must all follow the same format of
  ```
  !!! header
      body
  ```

For the strange lists, this is allowed and renders correctly, but it
looks strange:

```md
- first bullet
- second bullet
    still second bullet
- third bullet

    has a paragraph
    of text inside

- last bullet

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-04-29 17:25:11 -06:00
Travis Nielsen 7c9ef07659 object: move bucket notifications to stable
Bucket notifications and topics have been implemented since
v1.8 and have been stable. Therefore, with v1.11 we move
the feature to stable.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2023-01-04 10:30:14 -07:00
xiaobaowen 8f23c1ba9e docs: fix notes in CephBucketTopic docs
Signed-off-by: xiaobaowen <xiaobaowen@deeproute.ai>
2022-12-09 10:41:14 +08:00
Alexander Trost 74431443e3 docs: use mkdocs and restructure docs
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-05-18 16:06:22 +02:00