This improves the text in client-setup.rst.
We should make certain that the technical details
in this file remain current in July 2021. This
file was origingally written in November 2019.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/42518/head:
doc/cephadm: update about disabling logging to journald for quincy
doc/cephadm: remove repeated section on disabling logging to stderr
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
This PR rewrites a section in the Troubleshooting
chapter of the Cephadm Guide. The material that this
section discusses has been covered already in the
Cephadm Guide in the Cephadm Operations chapter.
There's no reason to repeat this information twice,
unless adding technical debt to the documentation
is our goal (which of course it is not, and the
opposite of adding technical debt to the documentation
has been the aim that has guided my work these past
six months).
Signed-off-by: Zac Dover <zac.dover@gmail.com>
The positions of two words are interchanged:
scans each cluster in the host ----> scans each host in the cluster
Signed-off-by: "Wang,Fei" <wf.ab@126.com>
This PR improves the readability and format
of the troubleshooting.rst file. This also
makes a change to the markdown of one of the
sub-subsections so that it is made of tildes
(~) instead of carets (^), because that's
the RST standard.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This (very long) PR does a few things:
- Rewrites the "Data Location" section of the Operations
docs
- Rewrites the "Health Checks" section of the Operations
docs
- Adds prompts to commands
- Adds console-output formatting to the places where it
is appropriate
- Adds several section headers where appropriate, to
signpost to the reader what is currently under discussion
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR turned out to be a 3-in-1:
(1) improves syntax and formatting of "Logging to stdout"
(2) improves syntax and formatting of "Logging to files"
(3) replaces all carets with tildes in 3rd-level section
headers in operations.rst (./build-doc was crying
about inconsistency when I fed it tildes, but tildes
and not carets are the RST standard according to
https://docutils.sourceforge.io/ \
docs/user/rst/quickstart.html#sections
so the carets had to go.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
ceph orch host drain removes all daemons from a host so it can be safely removed
ceph orch host rm will only remove host that a safe to remove
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
This PR makes some improvements to the "Potential
Problems" section of the "Upgrading Ceph" chapter
of the cephadm documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the section "Canceling an Upgrade"
in the "Upgrading Ceph" chapter of the cephadm
documentation.
I removed an extraneous prompt and rewrote a sentence
so that it was congruent with other sentences in similar
places elsewhere in the documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the section "Monitoring the Upgrade"
in the "Upgrading Ceph" chapter of the cephadm documentation.
This PR introduces a couple of section breaks with signposting
information in their titles, and rewrites some sentences in order
to reduce the cognitive load of the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR (slightly) improves the text in the section "Starting
the Upgrade" in the "Upgrading Ceph" chapter of the cephadm
documentation.
This is a very minor update, and does little but bring the sentences
into agreement with many other sentences that I've already written.
This is done to give the reader an almost tabular sense of what to
expect when looking at our docs.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR makes a couple of minor improvements to the text under the
top-level section "Upgrading Ceph" in the "Upgrading Ceph" chapter of
the cephadm documentation.
This one, mercifully, contains only a couple of changes.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites and reformats the section "Disabling Automatic
Deployment of Daemons" in the "Service Management" chapter of the
cephadm guide.
I've rewritten some sentences, removed some "please"s, and added
some section titles so that the content in this is better
signposted.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
service-management.rst contained a section called
"Deployment of Daemons" that needed a rewrite by
a native English speaker.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes "Octopus" from the curl-based installation
procedure.
After we moved on to Pacific, referring to Octopus looks wrong.
It looks wrong because it now is wrong.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
