- 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 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>
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>
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>
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>
