Commit Graph

18 Commits

Author SHA1 Message Date
Matan Breizman
032f8cf601 doc/dev/developer_guide/tests-unit-tests: Add unit test caveat
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2022-11-21 14:56:24 +00:00
Kefu Chai
3c40db975c script/run_tox.sh: drop support of python2
since we don't support python2 anymore, there is not need to mention or
support python2 when performing tests

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-31 21:16:56 +08:00
Zac Dover
eb99594437 doc/dev: update unit-tests tox section
This commit
- alters the structure of the
  unit-test section of the Developer Guide
  that discusses the tox tool, which is
  used to run certain unit tests
- corrects some grammar
- updates the list of locations of tox.ini
  files
- This also incorporates N. Cutler's suggestions.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-22 22:24:19 +10:00
Zac Dover
0eaf991bd8 doc/dev: update auto pr validation section
This commit updates the "Automated PR Validation"
section of the "Basic Workflow" page in the
Developer Guide. This is part of a project that
aims to clean all of the sentences currently extant
in the Dev Guide, prior to a slight reorganization
of that guide for the sake of clarity and simplicity.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-17 00:32:58 +10:00
Anthony D'Atri
00d1948491
Merge branch 'master' into anthonyeleven/docs-46367 2020-11-24 12:27:31 -08:00
Anthony D'Atri
73435185a3 doc/dev/developer_guide: verb disagreement on "Testing: Unit Tests" page
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
Fixes: https://tracker.ceph.com/issues/46367
2020-11-19 23:08:23 -08:00
Neha Ojha
a24f40bb8d
Merge pull request #38172 from zdover23/wip-doc-dev-unit-test-list-update
doc/dev: update list in unit test section

Reviewed-By: Nathan Cutler <ncutler@suse.com>
2020-11-18 15:50:01 -08:00
Neha Ojha
becb9b6db2
Merge pull request #38133 from zdover23/wip-doc-dev-unit-tests-1-of-7
doc/dev: update unit test 1 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:19:42 -08:00
Neha Ojha
42c599bd1f
Merge pull request #38134 from zdover23/wip-doc-dev-unit-tests-2-of-7
doc/dev: update unit tests 2 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:18:55 -08:00
Zac Dover
491a2fa8dc doc/dev: update list in unit test section
This commit removes an unwanted extra
nested list layer from a list.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 03:35:19 +10:00
Zac Dover
0dd7b26fb3 doc/dev: update unit test declaration
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 01:13:37 +10:00
Zac Dover
19d34666a8 doc/dev: update unit test 1 of 7
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now reduce the reader's
cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:25:05 +10:00
Zac Dover
7425e96c86 doc/dev: update unit tests 2 of 7
This commit updates the "What does 'make
check' mean" section of the "Unit Tests" chapter
of the Developer Guide. It makes the wording a
bit less editorial and attempts to reduce the
reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:13:35 +10:00
Kefu Chai
e3abd2e7c8 doc/dev/developer_guide/tests-unit-tests: use literal "make check"
the ``make check`` is better than a hyper link here.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-05 09:46:57 +08:00
Kefu Chai
51b7b05026 doc/dev: fix broken "make check" link
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-05 09:46:57 +08:00
Sebastian Wagner
59d54f3df1 doc: rename orchestrator_cli -> orchestrator
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-17 10:24:01 +01:00
Sage Weil
01c36d9db7 mgr/ansible: remove
Signed-off-by: Sage Weil <sage@redhat.com>
2020-02-07 09:45:12 -06:00
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