Commit Graph

20 Commits

Author SHA1 Message Date
Jos Collin
efb23dd034
doc: fix broken links multimds and kcephfs
Fixes: https://tracker.ceph.com/issues/49372
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-02-22 20:38:22 +05:30
Zac Dover
e6596e10b1 doc/dev: intro: removing ceph-deploy mention
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>
2021-02-20 00:36:03 +10:00
zdover23
d6cf88fcea
Merge pull request #39546 from zdover23/wip-doc-dev-teuthology-intro-suites-inventory-rewrite-18-Feb-2021
doc/dev: t5logy: rewrite "suites inventory"

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-19 21:13:11 +10:00
Josh Durgin
0c2164c2ab
Merge pull request #39556 from zdover23/wip-doc-dev-t8y-intro-how-integration-tests-are-run-rewrite-2021-Feb-19
doc/dev: t8y intro: edit "how to run int. tests"

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-02-18 12:27:29 -08:00
Zac Dover
ec199b916f doc/dev: t8y intro: edit "how to run int. tests"
This PR gives a bit more form to the section called
"how integration tests are run".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-19 03:19:25 +10:00
Zac Dover
cc362c2fd6 doc/dev: t7gy s/Priority/N/
"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>
2021-02-19 02:46:57 +10:00
Zac Dover
36287f21ce doc/dev: t5logy: rewrite "suites inventory"
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>
2021-02-18 21:08:27 +10:00
Zac Dover
e25c54c188 doc/dev: intro: rewrite "testing priority"
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>
2021-02-18 01:31:55 +10:00
zdover23
f3312bbdb3
Merge pull request #39497 from zdover23/wip-doc-dev-teuthology-intro-workbench-removal-16-Feb-2021
doc/dev: removing workbench docs (part 2)

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-17 12:16:47 +10:00
Zac Dover
67298e2492 doc/dev: correct "teuthology-describe-tests"
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>
2021-02-17 04:14:30 +10:00
Zac Dover
745934320d doc/dev: removing workbench docs (part 2)
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>
2021-02-17 03:45:49 +10:00
Zac Dover
07a9bf4d55 doc/dev: Teuthology guide PR#37949 grammar edit
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>
2021-02-17 00:55:39 +10:00
Zac Dover
f16402a962 doc/dev: cephfs-shell typo repair
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>
2021-02-16 18:37:13 +10:00
Zac Dover
81976b4f13 doc/dev: teuthology: improve triggering tests
- 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>
2021-02-16 00:43:14 +10:00
Zac Dover
ef198d8af5 doc/dev: rewrite 'testing qa changes'
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>
2021-02-15 23:27:34 +10:00
Zac Dover
3eaf27f01d doc/dev: rewrite "about suites and filters"
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>
2021-02-12 09:28:06 +10:00
Zac Dover
cce1fc800d doc/dev: rewrite "getting binaries" section
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>
2021-02-10 06:46:48 +10:00
Zac Dover
9ce222fee2 doc/dev: improving teuthology docs
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>
2021-01-26 16:53:34 +05:30
Deepika Upadhyay
4159d946d7 doc/dev/developer_guide/testing_integration_tests: fix broken links and
update teuthology guide

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:53:06 +05:30
Deepika Upadhyay
c77d0817d5 doc/dev/developer_guide: rearrange and improve docs
* move running-tests-using-teuth.rst to
doc/dev/developer_guide/tests-integration-testing-teuthology-workflow.rst

* introduce developer's guide for Sentry and improve teuthology docs

* add teuthology debugging guide * create testing_integration_tests
subfolder for teuthology

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:49:36 +05:30