Cosmetic documentation changes.
howto/accounts.rst
howto/ssh_access.rst
--------------------
o Fix gerrit port, should be 29418 VS 29419
o Mention the 'AddKeysToAgent' attribute, useful option.
howto/docs.voltha.org/quickstart.rst
------------------------------------
o Remove blank lines
o Separate list items with comma.
Change-Id: I197fd1ebf71609791dddeb41e42c738317ac6b68
diff --git a/howto/docs.voltha.org/quickstart.rst b/howto/docs.voltha.org/quickstart.rst
index 25743fe..df4a019 100644
--- a/howto/docs.voltha.org/quickstart.rst
+++ b/howto/docs.voltha.org/quickstart.rst
@@ -18,7 +18,7 @@
# Create a developer branch
git checkout -b dev-joey
-.. code-block: shell-session
+.. code-block:: shell-session
:linenos: 2
# Clone repo:voltha-docs
@@ -28,10 +28,10 @@
git checkout -b dev-joey
Repositories:
-`gerrit <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_
-`github <https://github.com/opencord/voltha-docs>`_
+[`gerrit <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_],
+[`github <https://github.com/opencord/voltha-docs>`_]
-.. code-block: shell-session
+.. code-block:: shell-session
:linenos: 2,5
# Clone repo:voltha-docs
@@ -43,7 +43,7 @@
Interactive development
-----------------------
-.. code-block: shell-session
+.. code-block:: shell-session
:caption: Launch a browser for viewing local edits
:linenos: 4
@@ -56,7 +56,7 @@
Invoke checkin tests locally
----------------------------
-.. code-block: shell-session
+.. code-block:: shell-session
:linenos: 3
cd voltha-docs
@@ -78,13 +78,14 @@
* - make linkcheck
- Verify URLs inlined within rst files are valid
-Document and commit changes for ``git log``
--------------------------------------------
+Document and commit changes for git log
+---------------------------------------
-.. code-block: shell-session
- :linenos:
+.. code-block:: shell-session
- # Commit message: Line 1 symmarize changes with jira ticket linkage.
+ # Commit message:
+ # - symmarize changes with jira ticket linkage.
+ # - jenkins will update jira ticket with status when a job is run.
echo '[VOL-XXXX] update voltha.docs' > commit_message
# Commit message: Capture list of modified files
@@ -107,10 +108,50 @@
# Create a patch and request a code review
git review --reviewers email1 email2 email3
-Extra credit
--------------------------------------------
-.. code-block: shell-session
+Sample commit message
+---------------------
+
+.. code-block:: shell-session
+
+ # Line 1: Commit message summary for git log
+ # - 50cpl max else a warning displayed.
+ # - jira tickets are updated by jenkins as jobs are run.
+ [VOL-xxxx] - Update voltha docs
+
+ # Optional extra jira tickets related to the patch
+ [VOL-yyyy]
+ [VOL-zzzz]
+
+ jjb/pipeline/voltha/master/bbsim-tests.groovy
+ vars/installKind.groovy
+ vars/installKind.sh
+ --------------------------------------------------
+ o Refactor inlined installer logic into a standalone script for reuse.
+ o Updated voltha-system-tests makefiles, added a target to install
+ the kind command (centrally, consistent version!) similar to kail.
+
+Extra credit
+------------
+
+- Update `copyright notice <https://github.com/joey-onf/copyright/blob/origin/master/notice>`_ in the year files are modified (`repo:copyright <https://github.com/joey-onf/copyright>`_).
+
+- Syntax checking source
+
+.. code-block:: shell-session
+
+ make help | grep lint
+ make lint
+
+- make test
+
+.. code-block:: shell-session
+
+ make test # Invoke: make lint linkcheck
+
+- Warning triage and cleanup.
+
+.. code-block:: shell-session
make sterile
make html 2>&1 | sed -e 's/WARNING/\nWARNING/g' | less --ignore-case --hilite-search '/WARNING'