Add tox environment for spellcheck

[doc.git] / docs / guides / onap-developer / how-to-use-docs / include-documentation.rst

diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index 4e76f61..28c7aeb 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@ -43,9 +43,13 @@ Setup doc project
 These steps are performed only once for the doc project and include:
 
 (1) creating in the doc repository an initial:
+
   - sphinx master document index
+
   - a directory structure aligned with the document structure
+
   - tests performed in jenkins verify jobs
+
   - sphinx configuration
 
 (2) establishing an account at readthedocs connected with the doc
@@ -201,7 +205,7 @@ About GIT branches
 ------------------
 
 GIT is a powerful tool allowing many actions, but without respecting some rules
-the GIT structure can be quickly ugly and unmaintaible.
+the GIT structure can be quickly ugly and unmaintainble.
 
 Here are some conventions about GIT branches:
   - ALWAYS create a local branch to edit or create any file. This local branch
@@ -217,7 +221,9 @@ Here are some conventions about GIT branches:
 The day of the release, the repository owner will create a new branch to
 fix the code and documentation. This will represent the 'stable' code of the
 release. In this context:
+
   - NEVER push a new feature on a stable branch
+
   - Only bug correction are authorized on a stable branch using cherry pick method
 
 .. image:: git_branches.png
@@ -415,7 +421,7 @@ Download the DOC repository.
 
    git clone http://gerrit.onap.org/r/doc
 
-Update submodules, build documentation using tox & then open using any browser.
+Build documentation using tox local environment & then open using any browser.
 
 .. code-block:: bash
 
@@ -424,3 +430,17 @@ Update submodules, build documentation using tox & then open using any browser.
    firefox docs/_build/html/index.html
 
 .. note:: Make sure to run `tox -elocal` and not just `tox`.
+
+There are additional tox enviornment options for checking External URLs and Spelling.
+Use the tox environment options below and then look at the output with the Linux `more` or
+similar command for scanning for output that applies to the files you
+are validating.
+
+.. code-block:: bash
+
+   tox -elinkcheck
+   more <  docs/_build/linkcheck/output.txt
+
+   tox -espellcheck
+   more <  docs/_build/spellcheck/output.txt
+