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>
Update some old typos that say "synk" instead of "snyk".
out of sync. This should fix the top-level README.md to use the latest
snyk security scan badge -- as opposed to only referring to the last one
that used the misspelled file from about a month ago.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
Rook has for quite some time only been focused on the Ceph
operator. Maintainers have only been focused on Ceph, and
the community has likewise been focused on Ceph. Now the docs
are updated to clarify that Ceph storage is the focus and
there are no plans for the project to support other storage
providers.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The info email list and rook-dev forum are targeted frequently by
spam and otherwise not used by the community. Let's focus on the
useful channels of slack, github, and security emails.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
With the storage providers all moving to separate repos, we clarify
the status and location of each storage provider. Also, no need to
mention the deprecated storage providers anymore.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
To ensure emails on the topics of security questions are sent to the
correct list, another link is added to the list of contacts.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The build status is only interesting to maintainers of the project
and is not really relevant to community members who are considering
running the project. The release builds are always considered stable
and whether the master build is intermittently failing is
not important to the community.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The YugabyteDB team has decided to move support of their operator
to a new repo at https://github.com/yugabyte/yugabyte-operator.
The operator in Rook is no longer needed. Further usage of
the YugabyteDB operator is recommended at the new location.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The cockroachDB operator has not had community support in Rook.
Therefore, the time has come to deprecate and remove it.
If the sources are still needed, there is always git history.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
There are several small updates to the readme, including changing
a reference of incubation status to graduation, removing the
framework as an independently listed status since the operator
versioning is the critical point that depends on the framework,
moving the security reporting under bug reports, and reordering
cassandra to be alphabetically before cockroach.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
To more quickly show the graduation status on the main readme,
we add a badge that shows rook is graduated.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The minio operator has not had community support nor
any updates since being added to Rook. Support is being
removed from Rook due to this lack of community interest.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Travis Nielsen
harshitasao
Jared Watts
Blaine Gardner
subhamkrai
bootjp / Yoshiaki Ueda
Sébastien Han
Alexander Trost
Anton Skriptsov
Dmitry Yusupov
Anton Skriptsov
Sameer Kulkarni
Louis Taylor
hchiramm
Bassam Tabbara
Dmitry Yusupov
Yannis Zarkadas
rohan47
Chris Aniszczyk