We should not link the dev guide form the user documentation. The user docs are already convoluted and hard to follow. Adding the dev guide is not helpful.
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
- Rewrote a sentence about forking.
- s/exactly how to proceed/how to proceed/
- Changed titles to present participles
- Rewrote "Fixing the Bug Locally" to improve its elegance.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit
- alters the structure of the
unit-test section of the Developer Guide
that discusses the tox tool, which is
used to run certain unit tests
- corrects some grammar
- updates the list of locations of tox.ini
files
- This also incorporates N. Cutler's suggestions.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit updates the "Automated PR Validation"
section of the "Basic Workflow" page in the
Developer Guide. This is part of a project that
aims to clean all of the sentences currently extant
in the Dev Guide, prior to a slight reorganization
of that guide for the sake of clarity and simplicity.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Added a generic Error component for HTTP Errors such as 404,403,501
Fixes:https://tracker.ceph.com/issues/39128
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now reduce the reader's
cognitive load.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit updates the "What does 'make
check' mean" section of the "Unit Tests" chapter
of the Developer Guide. It makes the wording a
bit less editorial and attempts to reduce the
reader's cognitive load.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit changes the noun "backup" to the
intended verb "back up" (this is one of my
technical documentation pet peeves and I couldn't
resist), and it also removes the verb "to nuke"
and replaces it with something less poetic but
more likely to be discoverable in a dictionary by
someone whose English is weak. It also adds a
missing colon.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit fixes the references to the
"make check" section in the "notes on
pr make check test" section and improves
the wording of that section so that it
reads a bit more clearly.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add a feature design section to the dashboard dev
guide, linking to the individual docs under dov/dev/dashboard
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
This updates a date from 2016 to 2020,
so that readers can be confident that the
procedure that they're reading has been recently
tested.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
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>
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>
