Commit Graph

6 Commits

Author SHA1 Message Date
Neha Ojha
deb7d811e0
Merge pull request #39695 from zdover23/wip-doc-dev-t8y-debugging-adding-sections-2021-Feb-26
doc/dev: add t8y debug section names

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-25 17:08:30 -08:00
Zac Dover
25a914229a doc/dev: rewrite t8y "reporting the issue"
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>
2021-02-26 00:38:11 +10:00
Zac Dover
dc87477a1a doc/dev: add t8y debug section names
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>
2021-02-26 00:15:56 +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
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