This PR rewrites the section of the Teuthology
documentation that is about the --interactive-
on-error flag.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
I added "(Teuthology)" to the "Tests: Integration
Tests" link, because that section is all about Teuthology,
but you wouldn't have known it from the text in the link
up to now.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the "Analyzing and Debugging a
Teuthology Job" section of the "Debugging Tips"
page of the Teuthology User Guide in the Developer
Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
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>
This commit simplifes and clarifies the "Triaging
the Cause of Failure" section in the Teuthology
Guide in the Developer Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the "Naming the Ceph Branch"
section of the Teuthology docs, improving its
elegance and unburying the ledes.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
s/getting tests results/getting test results/
This commit changes a title so that it is grammatically
correct. The adjective "test" now properly modifies the
noun "results". Another way of thinking of this is that
the complex noun "test results" has had a typo in it
corrected.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit makes one sentence slightly less
ambiguous by designating the location from
which the "ceph fetch" command fetches objects.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
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>
"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>
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>
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>
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>
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>
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>
Add a few notes about possible future scalability improvements
Co-authored-by: Joshua Schmid <jschmid@suse.de>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.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>
* refs/pull/39039/head:
src/test/cli/monmaptool: adjust for new monmap features
qa/tasks/cephadm: allow custom git_url for cephadm_branch pull
qa/suites/rados/upgrade: include pacific-x
qa/suites/upgrade/pacific-x/parallel
qa/suites: some clean up for quincy
mon: updates for quincy
mon: update for quincy ondisk features
script: add pacific
doc/dev/release-checklist: we tagged v17.0.0
ceph-volume: change to quincy
include/ceph_features: retire MON_SINGLE_PAXOS
include/ceph_features: define FEATURE_SERVER_QUINCY
mon/MgrMonitor: add always_on_modules for quincy
add feature/release name quincy
kickoff v17 quincy
doc/dev/release-checklists: uncheck everything!
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
- remove upgrades from nautilus
- stubs for completing upgrade to quincy
Still missing the pacific-x upgrade tests.
Signed-off-by: Sage Weil <sage@newdream.net>
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>
A first document where to discuss how to improve and make more easy and effective for final users the storage devices and OSD management.
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
... fix some typos and reorganize sections to be reader
friendly. Also include a requirements section.
Signed-off-by: Venky Shankar <vshankar@redhat.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>
it is time-consuming to rebuild the python bindings every time we
rebuild the document, it'd be ideal if we could just build document.
in this change, in addition to "html" and "doc", "livehtml" argument is
now supported by build-doc script, so one can just use
./build-doc livehtml
to build and start a web server. whenever a change in doc/ is detected,
the document is rebuilt. for more details, see
https://pypi.org/project/sphinx-autobuild/
Signed-off-by: Kefu Chai <kchai@redhat.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>
doc/dev/cephadm: high level design for a compliance check feature
Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
Development document defining the goals, requirements,
design and implementation details for the exporter mode
of the cephadm 'binary'
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/ for docs
Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Willem Jan Withagen <wjw@digiware.nl>
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>
