Commit Graph

20 Commits

Author SHA1 Message Date
Milind Changire
7830383a1b
doc/dev/developer_guide/testing_integration_tests: Document the random selection operator
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>
2023-03-30 21:17:51 +05:30
Matan Breizman
c2642a97f3 doc/dev/developer_guide/testing_integration_tests: Add Upgrade Testing Documentation
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2023-01-29 10:25:30 +00:00
Josh Soref
8abce157f1 doc: Fix many spelling errors
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2022-07-02 23:38:18 -04:00
Patrick Donnelly
c4d3040b70
doc/dev: document nested subsets in teuthology
See also: https://github.com/ceph/teuthology/pull/1704

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-03-25 09:12:56 -04:00
Patrick Donnelly
547b21c0de
doc: document PI .qa symlinks
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-02-03 10:08:30 -05:00
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
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