Improve a couple of sentences in
doc/dev/developer_guide_testing_integration_tests/tests-integration-testing-teutology-workflow.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
In tests-integration-testing-teuthology-workflow.rst,
briefly mention unit_test_summary.yaml and valgrind.yaml
as other files that exist in teuthology archive.
Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>
Document about the '$' operator which is the random selection operator.
Fixes: https://tracker.ceph.com/issues/55198
Signed-off-by: Milind Changire <mchangir@redhat.com>
* refs/pull/46421/head:
doc/dev: move option -R to a different section of doc
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
It's incorrect to pass option "-R fail" to the teuthology-suite command
meant for triggering tests for first time. teuthology-suite command will
fail if "-R" is passed without "-r". Therefore, move this option and its
description from the section meant for triggering tests for first time
to the section dedicated to re-running of tests.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
The `subset` option is important in Teuthology runs for reducing the number of tests that are triggered. This option is outlined in another part of the Teuthology documentation, but I think it's important to place here as well.
Also, -n (for how many times the job will run) is incorrect; it should be -N.
Signed-off-by: Laura Flores <lflores@redhat.com>
This PR rewrites the section of the Teuthology
documentation that is about the --interactive-
on-error flag.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the "Analyzing and Debugging a
Teuthology Job" section of the "Debugging Tips"
page of the Teuthology User Guide in the Developer
Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit rewrites the "Reporting the Issue"
section, reflecting my better understanding of the
various tools and parties in play. I also added a
TL;DR-style summary (or argument) paragraph at the
top of the section.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit adds two section headings to the
Debugging section of the Teuthology Guide:
1. Viewing Test Results
2. Identifying Failed Jobs
The text as it stood before seemed to call out for
this explicit sectioning of material, so I've answered
that call.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit simplifes and clarifies the "Triaging
the Cause of Failure" section in the Teuthology
Guide in the Developer Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the "Naming the Ceph Branch"
section of the Teuthology docs, improving its
elegance and unburying the ledes.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
s/getting tests results/getting test results/
This commit changes a title so that it is grammatically
correct. The adjective "test" now properly modifies the
noun "results". Another way of thinking of this is that
the complex noun "test results" has had a typo in it
corrected.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This removes a mention of the ceph-deploy manpage.
We also no longer direct people to use horses as
a primary form of transportation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
"N" just looks better in this table than does
"Priority". I've been thinking about this all
day, and I just decided to make this change.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This really just re-organizes this information into
a table. I think tables are easier to read than what
was here before.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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 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>
