Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Refactor documentation for ceph provider #8693

Merged
merged 1 commit into from Sep 13, 2021

Conversation

travisn
Copy link
Member

@travisn travisn commented Sep 10, 2021

Description of your changes:
With the nfs and cassandra providers moving to their own repo we can simplify the Ceph docs a bit. Some obsolete documentation is also removed.

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: Add the flag for skipping the build if this is only a documentation change. See here for the flag.
  • Skip Unrelated Tests: Add a flag to run tests for a specific storage provider. See test options.
  • Reviewed the developer guide on Submitting a Pull Request
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.
  • Pending release notes updated with breaking and/or notable changes, if necessary.
  • Upgrade from previous release is tested and upgrade user guide is updated, if necessary.
  • Code generation (make codegen) has been run to update object specifications, if necessary.

Copy link
Member

@leseb leseb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice refactor!


## TL;DR

If you're feeling lucky, a simple Rook cluster can be created with the following kubectl commands and [example manifests](https://github.com/rook/rook/blob/{{ branchName }}/cluster/examples/kubernetes/ceph).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "feeling lucky" lacks a bit of confidence even though it probably has a humoristic tone. Should we keep it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think it's better to remove

With the nfs and cassandra providers moving to their own repo
we can simplify the docs a bit. Some obsolete documentation
is also removed.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
@travisn travisn merged commit 235d5a3 into rook:master Sep 13, 2021
travisn added a commit that referenced this pull request Sep 13, 2021
docs: Refactor documentation for ceph provider (backport #8693)
parth-gr pushed a commit to parth-gr/rook that referenced this pull request Sep 14, 2021
docs: Refactor documentation for ceph provider
Signed-off-by: parth-gr <paarora@redhat.com>
@travisn travisn deleted the cleanup-docs branch February 24, 2022 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants