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>
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>
- 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>
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>
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>
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>
This PR removes the "running-tests-in-cloud.rst"
file, which explains how to use ceph-workbench.
ceph-workbench is now deprecated, and the new
Teuthology documentation supplants the information
in the ceph-workbench-related documentation.
This PR also alters the "index.rst" file to remove
a link to "running-tests-in-cloud.rst".
Fixes: https://tracker.ceph.com/issues/49109 (partially)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
This commit removes Lenz Grimmer's name and github
handle from the list of component leads and replaces
it with Ernesto Puerta's name and github handle.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
We should not link the dev guide form the user documentation. The user docs are already convoluted and hard to follow. Adding the dev guide is not helpful.
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
- Rewrote a sentence about forking.
- s/exactly how to proceed/how to proceed/
- Changed titles to present participles
- Rewrote "Fixing the Bug Locally" to improve its elegance.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
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>
Added a generic Error component for HTTP Errors such as 404,403,501
Fixes:https://tracker.ceph.com/issues/39128
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
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>
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>
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>
This commit changes the noun "backup" to the
intended verb "back up" (this is one of my
technical documentation pet peeves and I couldn't
resist), and it also removes the verb "to nuke"
and replaces it with something less poetic but
more likely to be discoverable in a dictionary by
someone whose English is weak. It also adds a
missing colon.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit fixes the references to the
"make check" section in the "notes on
pr make check test" section and improves
the wording of that section so that it
reads a bit more clearly.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add a feature design section to the dashboard dev
guide, linking to the individual docs under dov/dev/dashboard
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
This updates a date from 2016 to 2020,
so that readers can be confident that the
procedure that they're reading has been recently
tested.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit exposes HACKING.rst through the
docs website. Formerly, HACKING.rst was just
a file that existed at /src/pybind/mgr/dashboard/
HACKING.rst. This commit also updates README.rst
to point to the new location of HACKING.rst.
Fixes: https://tracker.ceph.com/issues/47230
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* use "code-block:: yaml" for qa suite samples
* use "prompt:: bash $" for shell commands using a non-root user
Signed-off-by: Kefu Chai <kchai@redhat.com>
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>
This commit adds an example of proper Merge PR format
to the Developer Guide. Though this might not be of
great use to most people, Zac Dover will find it most
helpful.
Fixes: https://tracker.ceph.com/issues/46843
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit adds "zdover" to the list of
leads as the Docs Lead.
Fixes: https://tracker.ceph.com/issues/46378
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This bug changes the sentence "If your patches emit
messages to the Ceph cluster log, please consult this
guidance:" to "If your patches emit messages to the
Ceph cluster log, please consult this:". This new sentence
is more natural and idiomatic.
Fixes: https://tracker.ceph.com/issues/46363
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit fixes a few sentences in the "Essentials" page
that aren't as well-formed as they might have been. This commit
fixes the issue detailed in the tracker link, as well as a couple
of other improvements that I couldn't resist in the heat of the
moment.
Fixes: https://tracker.ceph.com/issues/46362
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add a section to "Running tests using teuthology" in "Developer's Guide"
that explains how to retest a branch without rebuilding binaries.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
as vstart_runner.py is compatible with python3, and so is the tests
under `qa/` directory.
and use `pip` to install teuthology, simpler this way.
Signed-off-by: Kefu Chai <kchai@redhat.com>
This will isolate the network namespace for each mount point with
a private ip address and iptables, etc.
For the kill() stuff it will just do DOWN the veth interface instead
of sending ipmi request for kernel mount and kill the fuse processes
for the fuse mount. This could avoid sending the socket FIN to the
ceph cluster.
Fixes: https://tracker.ceph.com/issues/44044
Signed-off-by: Xiubo Li <xiubli@redhat.com>
Content of this page is being displayed twice, once on the left side of
the page and once within the page. Display it only once at the left
side of the page.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
The guide shows how to run integration tests using teuthology framework.
Fixes: https://tracker.ceph.com/issues/42749
Signed-off-by: Rishabh Dave <ridave@redhat.com>
* refs/pull/32144/head:
doc: mention multimds suite in dev guide
doc: clarify difference between fs and kcephfs suite
Reviewed-by: Varsha Rao <varao@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Add a new command-line switch to allow it to use the kernel client
instead, and add all of the machinery to handle local kcephfs mounts.
Document this in the developer guide, along with the appropriate scary
warnings about using this on a machine that you care about. While we're
in there, also correct a typo about FUSE configuration.
Fixes: https://tracker.ceph.com/issues/41910
Signed-off-by: Jeff Layton <jlayton@redhat.com>
Add an option "--clear-old-log" to get rid of log entries before making
entries for current batch of tests.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
stdout of ps command is generally pretty huge which makes it harder to
interpret logs. Don't print it by default and add "--log-ps-output" to
enable printing it.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
Add "--teardown" option so that vstart_runner.py tears down Ceph
cluster automatically after the batch of tests has completed running.
Also delete build/dev and build/out directories, after running stop.sh.
Update the doc for vstart_runner.py as well.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
Commit 3bb68e89f4 added a new subchapter under
"Testing -> Integration tests", but with the wrong heading level. This commit
fixes that and, additionally, splits the "Testing" chapter into two chapters so
the subheadings appear in the Table of Contents.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
* refs/pull/29907/head:
doc: add a doc for vstart_runner.py
Reviewed-by: Varsha Rao <varao@redhat.com>
Reviewed-by: Jeff Layton <jlayton@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Describe how to install teuthology, use vstart_runner.py to run tests
locally and briefly describe internals of vstart_runner.py
Signed-off-by: Rishabh Dave <ridave@redhat.com>
