summaryrefslogtreecommitdiffstats
path: root/doc (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #49725 from anthonyeleven/56521zdover232023-01-161-4/+13
|\ | | | | | | | | doc/releases: Clarify Quincy CephFS MDS upgrade process Reviewed-by: Zac Dover <zac.dover@gmail.com>
| * doc/releases: Clarify Quincy CephFS MDS upgrade processAnthony D'Atri2023-01-121-4/+13
| | | | | | | | Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
* | Merge pull request #49747 from zdover23/wip-doc-2023-01-16-luks-versionsAnthony D'Atri2023-01-161-4/+1
|\ \ | | | | | | doc/ceph-volume: update LUKS docs
| * | doc/ceph-volume: update LUKS docsZac Dover2023-01-151-4/+1
| | | | | | | | | | | | | | | | | | | | | | | | Remove references that claim that Ceph uses only LUKS version 1. https://tracker.ceph.com/issues/58354 Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | | Merge pull request #49716 from ↵zdover232023-01-161-31/+37
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | zdover23/wip-doc-2023-01-12-rbd-iscsi-initiator-linux-prompts doc/rbd: refine iscsi-initiator-linux.rbd Reviewed-by: Ilya Dryomov <idryomov@redhat.com> Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * | doc/rbd: format iscsi-initiator-linux.rbd betterZac Dover2023-01-151-31/+37
| | | | | | | | | | | | | | | | | | Add prompts and clean up the lists in doc/rbd/iscsi-initiator-linux.rbd. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | | doc/start: add RST escape character rules for boldZac Dover2023-01-151-0/+21
|/ / | | | | | | | | | | Explain how to escape the bold notation (**) within words in RST. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* / doc/dev: add git branch management commandsZac Dover2023-01-131-0/+32
|/ | | | | | | Add git branch deleting and search commands to the "Basic Workflow" page of the Developer Guide. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/dev: add push.autoSetupRemote instructionsZac Dover2023-01-111-0/+23
| | | | | | | | Explain how to set up push.autoSetupRemote so that the origin branch is properly set up when running "get push" without the need for the "--set-upstream" option. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/cephadm: s/osd/OSD/ where appropriateZac Dover2023-01-111-2/+2
| | | | | | | | Capitalize the initialization "OSD" where it occurs in natural language in cephadm/host-management.rst. This PR answers a request made by Anthony D'Atri and seconded by Cole Mitchell in https://github.com/ceph/ceph/pull/49699#discussion_r1066171002. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Merge pull request #49699 from ↵colemitchell2023-01-101-9/+14
|\ | | | | | | | | | | | | zdover23/wip-doc-2023-01-11-cephadm-host-management-removing-hosts doc/cephadm: refine "Removing Hosts" Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * doc/cephadm: refine "Removing Hosts"Zac Dover2023-01-101-9/+14
| | | | | | | | | | | | | | An intended edit to remove a redundant indefinite article became a longer (but still brief) full editorial pass. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | Merge pull request #49703 from ↵colemitchell2023-01-101-1/+1
|\ \ | | | | | | | | | | | | | | | | | | zdover23/wip-doc-2023-01-11-rados-operations-move-colon doc/rados: move colon Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
| * | doc/rados: move colonZac Dover2023-01-101-1/+1
| |/ | | | | | | | | | | Move colon in add-or-rm-osds.rst so that the sentence reads properly. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* / doc/css: add top-bar padding for h3 html elementZac Dover2023-01-101-0/+4
|/ | | | | | Add "scroll-margin-top: 4em;" property to h3 html element. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Merge pull request #49692 from zdover23/wip-doc-2023-01-11-header-fixzdover232023-01-101-0/+4
|\ | | | | | | | | doc/css: add "span" padding to custom.css Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * doc/css: add "span" padding to custom.cssZac Dover2023-01-101-0/+4
| | | | | | | | | | | | | | | | | | | | Add "scroll-top-bar: 2em;" for the "span" html element in custom.css so that the top bar doesn't get in the way of headings bounded by the "span element". See also https://github.com/ceph/ceph/pull/49644. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | doc/man/ceph-rbdnamer: remove obsolete udev ruleIlya Dryomov2023-01-101-9/+4
| | | | | | | | | | Fixes: https://tracker.ceph.com/issues/58398 Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
* | doc: document the relevance of mds_namespace mount optionJos Collin2023-01-103-1/+34
|/ | | | | Fixes: https://tracker.ceph.com/issues/57673 Signed-off-by: Jos Collin <jcollin@redhat.com>
* doc/rados: link to cephadm replacing osd sectionZac Dover2023-01-092-0/+4
| | | | | | | | | | Direct readers to the "Replacing an OSD" section in the cephadm documentation, for cases in which the instructions in "Replacing an OSD" in the RADOS documentation don't work. https://tracker.ceph.com/issues/58401 Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/glossary: Clean up "Ceph Object Storage"Zac Dover2023-01-081-13/+10
| | | | | | | | | Remove redundant material under the "Ceph Object Storage" headword and add a "See 'Ceph Object Store'" link. A future PR will provide a couple of sentences that explain how object storage is what's really supporting both CephFS and RBD. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc: fix a typoBrad Fitzpatrick2023-01-071-1/+1
| | | Signed-off-by: Brad Fitzpatrick <brad@danga.com>
* Merge pull request #49658 from zdover23/wip-doc-2023-01-15-h2-scroll-margin-topzdover232023-01-061-0/+4
|\ | | | | | | | | doc/css: Add scroll-margin-top to h2 html element Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * doc/css: Add scroll-margin-top to h2 html elementZac Dover2023-01-061-0/+4
| | | | | | | | | | | | | | | | | | Add "scroll-margin-top: 4em;" to the h2 html element's definition in custom.css. This moves the text under all h2 html elements out of the way of the sticky-header-style top bar, which previously obscured the text. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | Merge pull request #49653 from zdover23/wip-doc-2023-01-06-crushtool-optionszdover232023-01-061-0/+10
|\ \ | |/ |/| | | | | | | doc/man: define --num-rep, --min-rep and --max-rep Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com> Reviewed-by: Laura Flores <lflores@redhat.com>
| * doc/man: define --num-rep, --min-rep and --max-repZac Dover2023-01-061-0/+10
| | | | | | | | | | | | | | | | | | | | Explain the "--num-rep", "--min-rep", and "--max-rep" options, which are required when running "crushtool" commands with the "--show-mappings" flag. Originally reported by Brad Fitzpatrick. https://tracker.ceph.com/issues/58374 Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | Merge pull request #49643 from ↵zdover232023-01-061-0/+4
|\ \ | |/ |/| | | | | | | | | zdover23/wip-doc-2023-01-05-add-padding-to-sections doc/_static: add scroll-margin-top to custom.css Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * doc/_static: add scroll-margin-top to custom.cssZac Dover2023-01-051-0/+4
| | | | | | | | | | | | | | Add 4em of padding to the class "section", so that linked-to destinations are not obscured by the top bar. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | doc: Updating Foundation members for January 2023Mike Perez2023-01-061-10/+11
|/ | | | Signed-off-by: Mike Perez <thingee@gmail.com>
* doc/css: add scroll-margin-top to dt elementsZac Dover2023-01-051-0/+4
| | | | | | | | | | | | add "scroll-margin-top: em3;" to custom.css so that the header bar doesn't obscure the text of headwords in glossary.rst. Note that this applies only to elements in the documentation that are rendered into HTML with the dt (which stands for "description term" or "description list") tag. Other modifications will be necessary in order to ensure that the anchor points of non-dt elements are not obscured by the header bar. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Merge pull request #49620 from bradfitz/bradfitz/doczdover232023-01-032-3/+3
|\ | | | | | | | | doc: fix a couple grammatical things Reviewed-by: Zac Dover <zac.dover@gmail.com>
| * doc: fix a couple grammatical thingsBrad Fitzpatrick2023-01-032-3/+3
| | | | | | | | Signed-off-by: Brad Fitzpatrick <brad@danga.com>
* | doc/start: add Anthony D'Atri's suggestionsZac Dover2023-01-021-8/+8
| | | | | | | | | | | | | | Add the suggestions made by Anthony D'Atri in https://github.com/ceph/ceph/pull/49609. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | doc/start: refine "Quirks of RST"Zac Dover2023-01-021-14/+21
|/ | | | | | | Refine the language that was added yesterday, language that explains how certain aspects of RST work. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/start: add link-related metadocumentationZac Dover2023-01-011-0/+60
| | | | | | | | | 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>
* doc/glossary: capitalize "DAS" correctlyZac Dover2022-12-311-1/+1
| | | | | | | | Correctly capitalize "Direct-Attached Storage" in the glossary. (And test the "Quincy" branch, which seems lately not to have picked up any docs backports.) Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/glossary: collate "releases" entriesZac Dover2022-12-301-10/+28
| | | | | | | | Collect the "Releases"-related entries together under the "Releases" headword, in order to give readers a sense at a glance of how the different kinds of releases relate to one another. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/rbd: refine rbd-exclusive-locks.rstZac Dover2022-12-291-49/+52
| | | | | | | Refine grammar (mostly semantics) in rbd-exclusive-locks.rst. Co-authored-by: Ilya Dryomov <idryomov@redhat.com> Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/glossary: s/an/each/ where it's neededZac Dover2022-12-291-1/+1
| | | | | | | s/an/each/ in accordance with the suggestion made by Anthony D'Atri here: https://github.com/ceph/ceph/pull/49590/files#r1058390357 Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Merge pull request #49584 from zdover23/wip-doc-2022-12-27-glossary-cleanupzdover232022-12-281-7/+6
|\ | | | | | | | | doc/glossary: clean OSD id-related entries Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
| * doc/glossary: clean OSD id-related entriesZac Dover2022-12-271-7/+6
| | | | | | | | | | | | | | Tidy up the sentences under the headwords "OSD fsid", "OSD id", and "OSD uuid". Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | Merge pull request #49587 from zdover23/wip-doc-2022-12-27-rbd-wuold-typoIlya Dryomov2022-12-271-1/+1
|\ \ | | | | | | | | | | | | | | | doc/rbd: s/wuold/would/ in rados-rbd-cmds.rst Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com> Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
| * | doc/rbd: s/wuold/would/ in rados-rbd-cmds.rstZac Dover2022-12-271-1/+1
| |/ | | | | | | | | | | s/wuold/would/ in rados-rbd-cmds.rst. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* / doc/dev/cephadm: fix host maintenance enter/exit syntax -Ranjini Mandyam Narasiodeyar2022-12-271-2/+2
|/ | | | Signed-off-by: Ranjini Mandyam Narasiodeyar <rmandyam@rmandyam.remote.csb>
* doc/glossary: disambiguate clausesZac Dover2022-12-261-10/+10
| | | | | | | Disambiguate various clauses, most of which contain forms of the verb "to require". Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Merge pull request #49569 from ↵colemitchell2022-12-251-1/+1
|\ | | | | | | | | | | | | zdover23/wip-doc-2022-12-26-start-documenting-ceph-backport-fix doc/start: update documenting-ceph.rst Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
| * doc/start: update documenting-ceph.rstZac Dover2022-12-251-1/+1
| | | | | | | | | | | | | | Add an article to documenting-ceph.rst in order to troubleshoot a backporting problem. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* | doc/glossary: improve glossary entriesZac Dover2022-12-251-26/+30
|/ | | | | | Improve multiple glossary entries. Signed-off-by: Zac Dover <zac.dover@gmail.com>
* doc/start: improve documenting-ceph.rstZac Dover2022-12-251-21/+60
| | | | | | | 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>
* Merge pull request #49558 from ↵colemitchell2022-12-241-3/+1
|\ | | | | | | | | | | | | zdover23/wip-doc-2022-12-24-rados-api-librados-intro-prompt-removal doc/rados: remove prompt from php.ini line Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>