This commit exposes HACKING.rst through the
docs website. Formerly, HACKING.rst was just
a file that existed at /src/pybind/mgr/dashboard/
HACKING.rst. This commit also updates README.rst
to point to the new location of HACKING.rst.
Fixes: https://tracker.ceph.com/issues/47230
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* use "code-block:: yaml" for qa suite samples
* use "prompt:: bash $" for shell commands using a non-root user
Signed-off-by: Kefu Chai <kchai@redhat.com>
for 2 reasons:
* sphinx renders codeblock using python syntax highlighting by default,
so it's not surprising that it highlight keywords like "export" in
command line samples. so to render command line code blocks, we'd
better specify the syntax explicitly for better rendering result.
* with the help of "prompt" directive, user is able to copy and paste
the command without the prompt. for instance, with the default
"::" directive, user will copy "$ ceph df", which is not very
convenient, but with "prompt" directive, user only copies
"ceph df".
Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit adds an example of proper Merge PR format
to the Developer Guide. Though this might not be of
great use to most people, Zac Dover will find it most
helpful.
Fixes: https://tracker.ceph.com/issues/46843
Signed-off-by: Zac Dover <zac.dover@gmail.com>
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.
Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
* refs/pull/36131/head:
doc: document cephfs mirroring dev work
test: add tests for `ceph fs mirror` family of commands
mds: track filesystem mirror peers in fsmap
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
`--smp` and `--cpuset` have been passed to crimson-osd by vstart.sh, so
no need to pass them when launching vstart.sh
Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit adds "zdover" to the list of
leads as the Docs Lead.
Fixes: https://tracker.ceph.com/issues/46378
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This bug changes the sentence "If your patches emit
messages to the Ceph cluster log, please consult this
guidance:" to "If your patches emit messages to the
Ceph cluster log, please consult this:". This new sentence
is more natural and idiomatic.
Fixes: https://tracker.ceph.com/issues/46363
Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/osd_internals/manifest.rst: add information about clone snap refcounting
Reviewed-by: Myoungwon Oh <myoungwon.oh@samsung.com>
Reviewed-by: Samuel Just <sjust@redhat.com>
This commit fixes a few sentences in the "Essentials" page
that aren't as well-formed as they might have been. This commit
fixes the issue detailed in the tracker link, as well as a couple
of other improvements that I couldn't resist in the heat of the
moment.
Fixes: https://tracker.ceph.com/issues/46362
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Last change was from 2011
* the file is not referenced anywhere
* the referenced file `cephconfig.jpg` doesn't exist
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
