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>
(cherry picked from commit c9d99e01a0)
Cleanup the resources created by subvolumegroup
when its deleted. Following resources will be cleaned up:
- OMAP value
- OMAP keys
- Clones
- Snapshots
- Subvolumes
Signed-off-by: sp98 <sapillai@redhat.com>
(cherry picked from commit ef00fdac53)
The teardown guide is updated with the guidelines to use
third person wording and be more concise. Also, remove
the list of CRDs from the example that easily becomes
outdated as the list changes from release to release.
Signed-off-by: travisn <tnielsen@redhat.com>
Current cluster teardown document assumes that there is only one
Rook/Ceph cluster. If not, the instruction written in this document
might delete the data of other clusters.
Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
The PSPs have long since been deprected. In K8s 1.21 the PSPs
were first deprecated, and support was completely removed
for them in 1.25. With Rook v1.11, the min supported version of
K8s is now 1.21. To reduce confusion in the documentation,
mention of the PSPs is now removed from the 1.11 docs.
For the corner case that users still require the PSPs,
the helm chart still contains the option for creating PSPs
or other users can still create the psp.yaml.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The cleanup guide is difficult to find under the storage configuration section
with so many other topics. We will show the cleanup guide also from the getting
started section to make it more discoverable.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
otherwise it will fail with the following message:
```
The CephCluster "rook-ceph" is invalid:
* metadata.finalizers: Invalid value: "": name part must be non-empty
* metadata.finalizers: Invalid value: "": name part must consist of alphanumeric characters, '-',
'_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name',
or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]')
* metadata.finalizers: Forbidden: no new finalizers can be added if the object is being deleted,
found new finalizers []string{""}
```
Signed-off-by: Andrey Arapov <andrey.arapov@nixaid.com>
The cluster CR doc is extremely long and in need of refactoring.
Now we have four new sub-topics for a host-based cluster,
PVC-based cluster, stretch cluster, and an external cluster.
Each of those topics has its own description and examples.
The main cluster CR topic still contains the details about
all the possible cluster CR settings.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Blaine Gardner
sp98
Anthony D'Atri
Redouane Kachach
travisn
Satoru Takeuchi
Andrey Arapov
Blaine Gardner
Alexander Trost