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
Fix doc #10619
Fix doc #10619
Conversation
@@ -265,7 +265,7 @@ scrubbing operations. | |||
|
|||
``osd scrub min interval`` | |||
|
|||
:Description: The maximum interval in seconds for scrubbing the Ceph OSD Daemon | |||
:Description: The minimal interval in seconds for scrubbing the Ceph OSD Daemon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you prefix the title of your commit message with the subcomponent your are changing ? see https://github.com/ceph/ceph/blob/master/SubmittingPatches.rst#preparing-and-sending-patches
in this case, it would be "doc: "
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tchaikov , of course, thanks
|
||
rbd map mypool/myimage --cluster *cluster name* | ||
rbd map mypool/myimage --cluster cluster name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chengweiv5 could you change it to cluster-name
and change the --cluster cluster name
to --cluster cluster-name
accordingly?
cluster name
might confuse user: there are two words.
other than |
@tchaikov cluster name shows up 6 times in this document, should I change all of them to cluster-name? |
@chengweiv5 no, just the one in |
@tchaikov ok, I'll update it. |
Signed-off-by: Chengwei Yang <yangchengwei@qiyi.com>
@@ -56,14 +56,14 @@ To list the cluster's keys and their capabilities, execute the following:: | |||
Placement Group Subsystem | |||
========================= | |||
|
|||
To display the statistics for all placement groups, execute the following:: | |||
To display the statistics for all placement groups, execute the following:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chengweiv5, does this fix a formatting problem in the output or silence a warning of sphinx?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if not, i'd recommend accompany the kill-trailing-spaces only changes with some more significant change.
Signed-off-by: Chengwei Yang <yangchengwei@qiyi.com>
Signed-off-by: Chengwei Yang <yangchengwei@qiyi.com>
Signed-off-by: Chengwei Yang <yangchengwei@qiyi.com>
updated, do not remove trailing space |
@@ -329,7 +329,7 @@ The ``quorum`` list at the end lists monitor nodes that are part of the current | |||
|
|||
This is also available more directly:: | |||
|
|||
$ ./ceph quorum_status | |||
ceph quorum_status |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you keep the $
? this is an example of command usage with its output. the idea is to show the interaction of input and output. so $
helps to differentiate the command line from its output.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay!
No description provided.