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>
GRPC metrics got deprecated in cephcsi
3.7.0 and the deprecated flags will get
removed in the next release. This PR
removes the deprecated metrics code which
allow us to run with older cephcsi as well.
Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
https://github.com/rook/rook/pull/11845 added dynamic label `mgr_role`.
The example yaml files are updated but this doc is missed.
I think it would be better to refer to `deploy/examples` but I find all
other places are not doing that. So keep it inlined to be consistent.
Signed-off-by: Bin Wang <bin.wang@mail.binwang.me>
Using the new configuration parameters prometheusEndpoint and
prometheusEndpointSSLVerify users can configure dashboard to
point to their prometheus instance.
closes: #12876
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
Documentation and examples used a deprecated annotation to set the Ingress class name. This commit replaces it with the correct version using spec.ingressClassName .
Signed-off-by: Marcel Lautenbach <mlautenb@gmail.com>
During reconciliation of cephobjectstore, Rook operator resets the value
of replica count by the HPA and HPA brings back it up when it notices
the desired count for replica change.
Signed-off-by: Jiffin Tony Thottan <jthottan@redhat.com>
Alexander TrostandTravis Nielsen
Blaine Gardner
Praveen M
Sunnatillo
Madhu Rajanna
Bin Wang
Redouane Kachach
wangzihao05
Marcel Lautenbach
Avan Thakkar
Tim Jones
Juan Miguel Olmo Martínez
Josh Soref
Jiffin Tony Thottan