This PR improves the English in the "Testing
Priority" section and makes a few structural
changes to make the intent clearer.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This tiny commit does this:
s/teuthology-describe-tests/teuthology-describe/
The name of this feature was changed from "teuthology-
describe-tests" to "teuthology-describe", and this
commit brings up to date the title of the section
detailing it.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This removes a paragraph in the section "How
Integration Tests Are Run" that described
ceph-workbench. ceph-workbench is deprecated,
so that paragraph is now gone.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the wording of the technical
information added to the documentation in PR#37949.
This is the second is a series of two PRs, which series
is dedicated to testing a workflow wherein developers
add technical information to the documentation and then
technical writers improve its presentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This corrects the formatting for a mention of
cephfs-shell. Previously, it was not properly
formatted. This commit adds two backticks before
the string "cephfs-shell", and adds to backticks
after it.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
- This PR cleans up the language in the "Triggering
Tests" section of the "Workflow" chapter of the
"Tests: Integration Tests" (Teuthology) guide.
- Added bash prompts.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the "Testing QA Changes (Without
Re-Building Binaries)" section of the Developer
Guide. I also tried to unbury the lede.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This improves the English in the section
"About Suites and Filters" in the new
Teuthology Guide in the Developer Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This rewrites the "Getting Binaries" section
of the "Workflow" section of the "Tests:
Integration Tests" section of the Developer Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes the "running-tests-in-cloud.rst"
file, which explains how to use ceph-workbench.
ceph-workbench is now deprecated, and the new
Teuthology documentation supplants the information
in the ceph-workbench-related documentation.
This PR also alters the "index.rst" file to remove
a link to "running-tests-in-cloud.rst".
Fixes: https://tracker.ceph.com/issues/49109 (partially)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes the following two sections:
1. Getting Ceph Workbench
2. Linking Ceph Workbench With Your OpenStack Tenant
Fixes: https://tracker.ceph.com/issues/48942
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit removes Lenz Grimmer's name and github
handle from the list of component leads and replaces
it with Ernesto Puerta's name and github handle.
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>
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>
