Commit Graph

7 Commits

Author SHA1 Message Date
Zac Dover
ebea923ffc doc:dev remove workbench sections
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>
2021-02-02 01:01:25 +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
Kefu Chai
0f2489406a doc/dev: use prompt directive when appropriate
for 2 reasons:

* sphinx renders codeblock using python syntax highlighting by default,
  so it's not surprising that it highlight keywords like "export" in
  command line samples. so to render command line code blocks, we'd
  better specify the syntax explicitly for better rendering result.
* with the help of "prompt" directive, user is able to copy and paste
  the command without the prompt. for instance, with the default
  "::" directive, user will copy "$ ceph df", which is not very
  convenient, but with "prompt" directive, user only copies
  "ceph df".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-05 00:03:52 +08:00
Rishabh Dave
cbcb829575 doc: fix links in developer_guide
Fixes: https://tracker.ceph.com/issues/43663
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-20 11:33:48 +05:30
Rishabh Dave
5f2e33570a doc: split index.rst of dev guide
Move every section to a different file. Also, fix minor issues like
line-wrapping along.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-14 15:12:27 +05:30