docs: add specific docs for each command and args #58

subhamkrai · 2022-09-15T07:22:21Z

This commits add docs for each command and args that the plugin supports and also, update the readme doc.

Signed-off-by: subhamkrai srai@redhat.com

docs/health.md

parth-gr

Looks good to me, just check the links are working fine :)

travisn

What about the following approach?

Keep a single readme in this repo where all the commands and args are basically documented
Create more detailed Rook docs with many examples. The Rook docs will have nice rendering, they're searchable, there can be a hierarchy of docs, and so on.

The downside is that the docs are disconnected from the krew repo, but it seems fine if it's just for more detailed examples.

travisn

Let's discuss

subhamkrai · 2022-09-15T16:39:47Z

Let's discuss

yeah, let's discuss.

travisn · 2022-09-15T17:12:24Z

Another thought on the approach of using Rook docs... If we keep the single usage page in the krew repo, more detailed scenarios could be integrated to the Rook docs. For example, in the Rook DR docs we should use the krew commands and show how the DR is working end to end, based on krew status or other commands.

BlaineEXE

Overall, I think this looks really good. Just a few thoughts that are pretty minor.

BlaineEXE · 2022-09-20T16:20:19Z

docs/health.md

+1. `Info`: This is just a logging information for the users.
+
+2. `Warning`: which mean there is some improvement required in the cluster.
+
+3. `Error`: This reuires immediate user attentions to get the cluster in healthy state.


Are these separated by newlines for a particular reason?

Suggested change

1. `Info`: This is just a logging information for the users.

2. `Warning`: which mean there is some improvement required in the cluster.

3. `Error`: This reuires immediate user attentions to get the cluster in healthy state.

1. `Info`: This is just a logging information for the users.

2. `Warning`: which mean there is some improvement required in the cluster.

3. `Error`: This reuires immediate user attentions to get the cluster in healthy state.

yes, for the markdown files vsCode was showing errors, and suggestions to keep one newling for the heading or this similar tables.

Edit: I have made the changes the warnings are only for headings

docs/health.md

docs/debug.md

docs/ceph.md

BlaineEXE · 2022-09-20T16:24:41Z

README.md

@@ -6,20 +6,50 @@ Provide common management and troubleshooting tools for the [Rook Ceph](https://

 ## Install

+Note: This required kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.


Suggested change

Note: This required kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.

!!! Note

This requires kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.

we are not re-directory these docs to the official rook doc, so not adding the ! ! ! Note format

README.md

travisn · 2022-09-26T23:29:56Z

README.md

+
+| Uses | Command | Args |
+| :--: |:-------:| :---:|
+| [Running ceph commands](docs/ceph.md) | `kubectl rook-ceph ceph <args>` | `<any ceph supported args>`|


Instead of a table, how about a bullet list of the pages? The table repeats a lot of details that were already shown above in the usage. As a table of contents, they just need links to the other pages, then they can find the details of the commands and output on those pages.

changed to a bullet list.

travisn

just some small formatting suggestions

README.md

docs/debug.md

docs/rook.md

travisn · 2022-09-28T16:56:45Z

docs/rook.md

+# objectbucketclaims.objectbucket.io:
+```
+
+## Status CR-Name


Suggested change

## Status CR-Name

## CephCluster Status

with these we have to pass cr name for which we want the status, so kept it like this

travisn

Looks great, just a few final nits

README.md

docs/debug.md

docs/operator.md

This commits add docs for each command and args that the plugin supports and also, update the readme doc. Signed-off-by: subhamkrai <srai@redhat.com>

subhamkrai added the documentation Improvements or additions to documentation label Sep 15, 2022

subhamkrai requested review from parth-gr, travisn, BlaineEXE and sp98 September 15, 2022 07:22

subhamkrai mentioned this pull request Sep 15, 2022

core: add command to check cluster health in dr #57

Merged

subhamkrai force-pushed the add-docs branch from 2879f0e to e83552c Compare September 15, 2022 07:33

parth-gr reviewed Sep 15, 2022

View reviewed changes

docs/health.md Outdated Show resolved Hide resolved

parth-gr approved these changes Sep 15, 2022

View reviewed changes

parth-gr self-requested a review September 15, 2022 09:56

subhamkrai force-pushed the add-docs branch from e83552c to 50445fa Compare September 15, 2022 11:41

travisn reviewed Sep 15, 2022

View reviewed changes

travisn requested changes Sep 15, 2022

View reviewed changes

subhamkrai force-pushed the add-docs branch 2 times, most recently from aa5b858 to ee1615f Compare September 19, 2022 12:25

BlaineEXE reviewed Sep 20, 2022

View reviewed changes

subhamkrai force-pushed the add-docs branch from ee1615f to fa85a50 Compare September 21, 2022 08:49

travisn requested changes Sep 26, 2022

View reviewed changes

travisn mentioned this pull request Sep 26, 2022

docs: update troubleshoot docs and add krew uses rook/rook#11017

Merged

7 tasks

subhamkrai force-pushed the add-docs branch from fa85a50 to b32e7e7 Compare September 28, 2022 09:31

travisn requested changes Sep 28, 2022

View reviewed changes

subhamkrai force-pushed the add-docs branch from b32e7e7 to 90bfb37 Compare September 29, 2022 06:21

subhamkrai requested a review from travisn September 29, 2022 06:21

travisn requested changes Sep 29, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

docs/debug.md Outdated Show resolved Hide resolved

docs/debug.md Outdated Show resolved Hide resolved

docs/operator.md Outdated Show resolved Hide resolved

docs: add specific docs for each command and args

0b6d9ab

This commits add docs for each command and args that the plugin supports and also, update the readme doc. Signed-off-by: subhamkrai <srai@redhat.com>

subhamkrai force-pushed the add-docs branch from 90bfb37 to 0b6d9ab Compare September 29, 2022 15:28

subhamkrai requested review from travisn and BlaineEXE September 29, 2022 15:29

travisn approved these changes Sep 29, 2022

View reviewed changes

BlaineEXE approved these changes Sep 29, 2022

View reviewed changes

BlaineEXE merged commit c7a0708 into rook:master Sep 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add specific docs for each command and args #58

docs: add specific docs for each command and args #58

subhamkrai commented Sep 15, 2022

parth-gr left a comment

travisn left a comment

travisn left a comment

subhamkrai commented Sep 15, 2022

travisn commented Sep 15, 2022

BlaineEXE left a comment

BlaineEXE Sep 20, 2022

subhamkrai Sep 21, 2022 •

edited

Loading

BlaineEXE Sep 20, 2022

subhamkrai Sep 21, 2022

travisn Sep 26, 2022

subhamkrai Sep 28, 2022 •

edited

Loading

travisn left a comment

travisn Sep 28, 2022

subhamkrai Sep 29, 2022

travisn left a comment

		@@ -6,20 +6,50 @@ Provide common management and troubleshooting tools for the [Rook Ceph](https://

		## Install

		Note: This required kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.

	Note: This required kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.
	!!! Note
	This requires kubectl [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) to be installed.

docs: add specific docs for each command and args #58

docs: add specific docs for each command and args #58

Conversation

subhamkrai commented Sep 15, 2022

parth-gr left a comment

Choose a reason for hiding this comment

travisn left a comment

Choose a reason for hiding this comment

travisn left a comment

Choose a reason for hiding this comment

subhamkrai commented Sep 15, 2022

travisn commented Sep 15, 2022

BlaineEXE left a comment

Choose a reason for hiding this comment

BlaineEXE Sep 20, 2022

Choose a reason for hiding this comment

subhamkrai Sep 21, 2022 • edited Loading

Choose a reason for hiding this comment

BlaineEXE Sep 20, 2022

Choose a reason for hiding this comment

subhamkrai Sep 21, 2022

Choose a reason for hiding this comment

travisn Sep 26, 2022

Choose a reason for hiding this comment

subhamkrai Sep 28, 2022 • edited Loading

Choose a reason for hiding this comment

travisn left a comment

Choose a reason for hiding this comment

travisn Sep 28, 2022

Choose a reason for hiding this comment

subhamkrai Sep 29, 2022

Choose a reason for hiding this comment

travisn left a comment

Choose a reason for hiding this comment

subhamkrai Sep 21, 2022 •

edited

Loading

subhamkrai Sep 28, 2022 •

edited

Loading