Blaine Gardner
1391228b1d
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)
79 lines
5.6 KiB
Markdown
79 lines
5.6 KiB
Markdown
<img alt="Rook" src="Documentation/media/logo.svg" width="50%" height="50%">
|
|
|
|
[](https://www.cncf.io/projects)
|
|
[](https://github.com/rook/rook/releases)
|
|
[](https://hub.docker.com/u/rook)
|
|
[](https://goreportcard.com/report/github.com/rook/rook)
|
|
[](https://bestpractices.coreinfrastructure.org/projects/1599)
|
|
[](https://github.com/rook/rook/actions/workflows/snyk.yaml)
|
|
[](https://slack.rook.io)
|
|
[](https://twitter.com/intent/follow?screen_name=rook_io&user_id=788180534543339520)
|
|
|
|
# What is Rook?
|
|
|
|
Rook is an open source **cloud-native storage orchestrator** for Kubernetes, providing the platform, framework, and support for Ceph storage to natively integrate with Kubernetes.
|
|
|
|
[Ceph](https://ceph.com/) is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters.
|
|
|
|
Rook automates deployment and management of Ceph to provide self-managing, self-scaling, and self-healing storage services.
|
|
The Rook operator does this by building on Kubernetes resources to deploy, configure, provision, scale, upgrade, and monitor Ceph.
|
|
|
|
The status of the Ceph storage provider is **Stable**. Features and improvements will be planned for many future versions. Upgrades between versions are provided to ensure backward compatibility between releases.
|
|
|
|
Rook is hosted by the [Cloud Native Computing Foundation](https://cncf.io) (CNCF) as a [graduated](https://www.cncf.io/announcements/2020/10/07/cloud-native-computing-foundation-announces-rook-graduation/) level project. If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Rook plays a role, read the CNCF [announcement](https://www.cncf.io/blog/2018/01/29/cncf-host-rook-project-cloud-native-storage-capabilities).
|
|
|
|
## Getting Started and Documentation
|
|
|
|
For installation, deployment, and administration, see our [Documentation](https://rook.github.io/docs/rook/latest-release) and [QuickStart Guide](https://rook.github.io/docs/rook/latest-release/Getting-Started/quickstart).
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions. See [Contributing](CONTRIBUTING.md) to get started.
|
|
|
|
## Report a Bug
|
|
|
|
For filing bugs, suggesting improvements, or requesting new features, please open an [issue](https://github.com/rook/rook/issues).
|
|
|
|
### Reporting Security Vulnerabilities
|
|
|
|
If you find a vulnerability or a potential vulnerability in Rook please let us know immediately at
|
|
[cncf-rook-security@lists.cncf.io](mailto:cncf-rook-security@lists.cncf.io). We'll send a confirmation email to acknowledge your
|
|
report, and we'll send an additional email when we've identified the issues positively or
|
|
negatively.
|
|
|
|
For further details, please see the complete [security release process](SECURITY.md).
|
|
|
|
## Contact
|
|
|
|
Please use the following to reach members of the community:
|
|
|
|
- Slack: Join our [slack channel](https://slack.rook.io)
|
|
- GitHub: Start a [discussion](https://github.com/rook/rook/discussions) or open an [issue](https://github.com/rook/rook/issues)
|
|
- Twitter: [@rook_io](https://twitter.com/rook_io)
|
|
- Security topics: [cncf-rook-security@lists.cncf.io](#reporting-security-vulnerabilities)
|
|
|
|
## Community Meeting
|
|
|
|
A regular community meeting takes place every other [Tuesday at 9:00 AM PT (Pacific Time)](https://zoom.us/j/98052644520?pwd=K0R4RUZCc3NhQisyMnA5VlV2MVBhQT09).
|
|
Convert to your [local timezone](http://www.thetimezoneconverter.com/?t=9:00&tz=PT%20%28Pacific%20Time%29).
|
|
|
|
Any changes to the meeting schedule will be added to the [agenda doc](https://docs.google.com/document/d/1exd8_IG6DkdvyA0eiTtL2z5K2Ra-y68VByUUgwP7I9A/edit?usp=sharing) and posted to [Slack #announcements](https://rook-io.slack.com/messages/C76LLCEE7/).
|
|
|
|
Anyone who wants to discuss the direction of the project, design and implementation reviews, or general questions with the broader community is welcome and encouraged to join.
|
|
|
|
- Meeting link: <https://zoom.us/j/98052644520?pwd=K0R4RUZCc3NhQisyMnA5VlV2MVBhQT09>
|
|
- [Current agenda and past meeting notes](https://docs.google.com/document/d/1exd8_IG6DkdvyA0eiTtL2z5K2Ra-y68VByUUgwP7I9A/edit?usp=sharing)
|
|
- [Past meeting recordings](https://www.youtube.com/playlist?list=PLP0uDo-ZFnQP6NAgJWAtR9jaRcgqyQKVy)
|
|
|
|
## Official Releases
|
|
|
|
Official releases of Rook can be found on the [releases page](https://github.com/rook/rook/releases).
|
|
Please note that it is **strongly recommended** that you use [official releases](https://github.com/rook/rook/releases) of Rook, as unreleased versions from the master branch are subject to changes and incompatibilities that will not be supported in the official releases.
|
|
Builds from the master branch can have functionality changed and even removed at any time without compatibility support and without prior notice.
|
|
|
|
## Licensing
|
|
|
|
Rook is under the Apache 2.0 license.
|
|
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Frook%2Frook?ref=badge_large)
|