Add a full stop to a sentence in basic-workflow.rst. I looked at this
document and noticed that it wasn't there, and it was just bugging me.
Signed-off-by: Zac Dover <zac.dover@proton.me>
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>
This commit corrects the formatting of a note that previously
did not make console output and commands as clear as this commit
makes them.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR adds a link to the "Basic Workflow" section of the
Developer Guide on the landing page of docs.ceph.com.
This PR is meant to improve the documentation for developers
new to Ceph and to guide them to instructions that will allow
them to become full-fledged contributors to the Ceph project
as quickly as possible.
The "Basic Workflow" page of the Developer Guide contains
information that answers almost all of the questions that I had
about contributing to the Ceph project when I was new to it,
and I am finally acting on my long-held conviction that the
"Basic Workflow" page of the Developer Guide should have a more
prominent position in the documentation suite than it has had.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR adds a note directing first-time cloners of
their Ceph git forks to make sure to cd into the ceph/
directory before trying to run the "git config" commands.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This changes "master" to "main" in a title. If we lived in an
ideal world, this would have been a part of PR#46678.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR changes "master" to "main" in the
basic_workflow.rst file. I have even changed
"master" to "main" in some terminal output from
several years ago. This isn't historically ac-
curate, of course, but my hope is that this change
will prevent someone in the future from being con-
fused about why an antiquated branch name is ref-
erred to.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This is one in a set of PRs meant to keep the Basic
Workflow in the Developer guide current. It refines
the English in the "Integration Tests AKA ceph-qa-suite"
section of "Basic Workflow".
Several other small updates like this are expected. I
intend to avoid refining half of the page in one commit,
as I did last month when I refined the first half of the
basic workflow.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR updates the basic-workflow.rst file
to serve the needs of people in 2022 who were not
present at jump street.
The text has been refined up to the section called
"Integration Tests" (non-inclusive).
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This corrects the heinous misspelling described in the
substitution expression in the title. This misspelling is
all the more egregious because it appears in a title, and
therefore would be used to create links if it had not been
caught.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit makes one sentence slightly less
ambiguous by designating the location from
which the "ceph fetch" command fetches objects.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit is a proof of concept and a repair of
links to the "Integration Tests" section of the
Developer Guide.
This fixes the "reading a standalone test" link
from the "Running Tests in the Cloud" page
to the "Reading a Standalone Test" section in
the "Tests: Integration Tests" page.
Signed-off-by: Zac Dover <zac.dover@gmail.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 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>
