Add a list of OSes that have been tested as container hosts. This commit
is added in response to a request made by Josh Durgin on Slack.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update the User and Dev mailing list subscription links. This commit is
made in response to a request from Dan van der Ster.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Remove "start/intro.rst", which has been renamed "start/index.rst" in
order to follow the conventions followed elsewhere in the documentation.
Follows https://github.com/ceph/ceph/pull/57900.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add letters to substeps in a procedure so that readers won't get too
confused by having numbered steps nested inside numbered steps.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Change the filename "doc/start/intro.rst" to "doc/start/index.rst" so
that Sphinx finds the root filename for the "/start" directory in the
default location.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Replace "http" with "https" in doc/start/get-involved.rst.
This commit is, in a way, a repeat of
https://github.com/ceph/ceph/pull/57213/
(1c5383b91b), which targeted the Reef
branch instead of the main branch. When this commit has been merged and
backported, I will close https://github.com/ceph/ceph/pull/57213/.
I am listing Casey Cain here as the co-author, but he is in fact the
true author of this change.
Co-authored-by: Casey Cain <ccain@linuxfoundation.org>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Make some improvements to the basic text of the Beginner's Guide.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add a link to the ceph-storage Slack invitation page. Previously the
link went to a plain old "this is the ceph-storage Slack" page that did
not direct the reader to sign up.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update "Quincy" to "Reef" and "Pacific" to "Quincy" in the section
"Viewing Old Ceph Documentation" in /doc/start/documenting-ceph.rst.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Explain the initialism "OSD" and link to its definition in the glossary.
This PR is raised in response to an anonymous documentation bug that reads
"Paragraph 2 uses the acronym OSD without any explanation.
This makes it very difficult to understand this part of
the documentation as there is no indication of what this
acronym is until much further into the documentation. Replace
first occurence of OSD with Object Storage Daemon (OSD) or
link it to the glossary."
-- https://pad.ceph.com/p/Report_Documentation_Bugs
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Improve the grammar in one sentence of the "Platforms" section of
doc/start/os-recommendations.rst. Improving that grammar involved
splitting the sentence into two sentences, but that's life. Update:
Anthony substantially rewrote this, so credit for this should rightly
go to him.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Refactor the ABC test chart so that the information about which tests
have been run is presented in the center of the chart instead of, as it
was before, in a superscript.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update the table that reports which versions of which Linux releases
have been used in tests of Ceph.
Fixes: https://tracker.ceph.com/issues/62354
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update linking conventions in doc/start/documenting-ceph.rst, as
requested in
https://github.com/ceph/ceph/pull/49889#issuecomment-1657750905 by
bluikko. This commit introduces a convention that could be read as
inconsistent with other conventions mentioned on the page altered by
this commit. Future PRs will attenuate this inconsistency.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add KRBD feature flag support note to doc/start/os-recommendations.rst.
This change was suggested by Anthony D'Atri in https://github.com/ceph/ceph/pull/51485.
Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
The 4.14 LTS kernel has less than a year left in terms of maintenance,
drop it.
Also, the current wording with an explicit list of kernels tends to go
stale: it's missing the latest 6.1 LTS kernel.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
Rewrite the first paragraph in doc/start/intro.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Edit the first 150 lines of doc/start/documenting-ceph.rst. This is part
of an initiative to harvest the fruits of Cephalocon 2023, at which
documentation proved to be in demand to a surprising degree.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add a link to the landing page of docs.ceph.com to direct documentation
contributors to documentation-related information.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Rewrite the "Notify Us" section in doc/start/documenting-ceph.rst so
that it is written in English sentences.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add a procedure to doc/start/documenting-ceph.rst that explains how to
perform an interactive rebase to squash commits.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add two kinds of link-related metadocumentation (documentation about how
to write documentation) to the "Documenting Ceph" section of the "Intro
to Ceph" document: 1. metadocumentation about external links, and 2.
metadocumentation about internal links.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Improve the grammar and the pragmatics of the "TOC and Hyperlinks"
section of start/documenting-ceph.rst.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
