Documentation Pass 2 (EMCECS#384)

* ECS-CommunityEdition-299 Add Community Documentation * ECS-CommunityEdition-299 Add Community Documentation * CoC * update issue template * update pull request template * remove contributing document * update .dockerignore * move old changelogs to docs/legacy * Reformat README * remove changelog.rst * Create Standard, Island, and OVA Installation guides * Update ECS-Installation.md to be ToC style page * wording * install node capitalization * create building docs * add build_image macro to run.sh * create building docs * create utilities.md doc * undo a whoops * add utilities references and address EMCECS#362
nikhil-vr · Nov 9, 2017 · 9a0b67c · 9a0b67c
1 parent 105ff62
commit 9a0b67c
Show file tree

Hide file tree

Showing 18 changed files with 1,164 additions and 362 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -12,7 +12,7 @@
 /README.md
 /bootstrap.sh
 /.gitignore
-/changelog.md
+/docs
 /ECS-CommunityEdition.iml
 /.gitattributes
 /.dockerignore

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -2,9 +2,18 @@
 
 
 ### Actual Behavior
-
+(Please put additional output and logs in the section for that below)
 
 ### Steps to Reproduce Behavior
 
+1.
+2.
+3.
+
+### Relevant Output and Logs
+```
+# Output and Logs go here
+```
 
-### Output
+---
+Notifies: @padthaitofuhot @captntuttle @adrianmo
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,11 +1,14 @@
-This pull request addresses the following issue(s): # .
+### This pull request addresses the following referenced issue(s):
 
+1.
+2.
+3.
 
-Overview of changes:
+### Overview of changes:
 
--
--
--
+1.
+2.
+3.
 
-
-@padthaitofuhot @captntuttle @adrianmo
+---
+@padthaitofuhot @captntuttle @adrianmo
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/README.md b/README.md
@@ -1,7 +1,14 @@
-[![Documentation Status](http://readthedocs.org/projects/ecsce/badge/?version=latest)](http://ecsce.readthedocs.io/en/latest/?badge=latest)
- <h1> ECS Community Edition </h1>
+# ECS Community Edition
+**ECS Software Image**
+[![](https://images.microbadger.com/badges/version/emccorp/ecs-software-3.1.0.svg)](https://microbadger.com/images/emccorp/ecs-software-3.1.0 "Get your own version badge on microbadger.com")
+**ECS CE Install Node Image**
+[![](https://images.microbadger.com/badges/version/emccorp/ecs-install.svg)](https://microbadger.com/images/emccorp/ecs-install "Get your own version badge on microbadger.com") [![Documentation Status](http://readthedocs.org/projects/ecsce/badge/?version=latest)](http://ecsce.readthedocs.io/en/latest/?badge=latest) [![Jenkins](https://img.shields.io/jenkins/s/https/jenkins.qa.ubuntu.com/view/Precise/view/All%20Precise/job/precise-desktop-amd64_default.svg?style=flat-square)](http://10.1.83.120/job/ecs-ce/)
+
+Current releases and history are available [here][releases].
+
+## Community Guides
+Please read our [Community Code of Conduct][ccoc] before contributing.  Thank you.
 
-See [release history](https://github.com/EMCECS/ECS-CommunityEdition/releases) for current release notes and change log; [changelog.md](changelog.md) file for legacy history.
 
 ## Description
 
@@ -85,12 +92,12 @@ Deploy a multi-node ECS instance to two or more hardware or virtual machines.  T
 
 ### Deployments into Soft-Isolated and Air-Gapped Island Environments
 ##### Important information regarding Island deployments
-Please be aware that Install Node bootstrapping requires Internet access to the hardware or virtual machine that will become the Install Node, but once this step is complete, the machine can be removed from the Internet and migrated into the Island environment.
+Please be aware that install node bootstrapping requires Internet access to the hardware or virtual machine that will become the install node, but once this step is complete, the machine can be removed from the Internet and migrated into the Island environment.
 
 #### Deploying from OVA
-In situations where Internet access is completely disallowed, or for the sake of convenience, an OVA of a prefabricated, bootstrapped, Install Node is provided.  Please download the OVA from one of the links below.
+In situations where Internet access is completely disallowed, or for the sake of convenience, an OVA of a prefabricated, bootstrapped, install node is provided.  Please download the OVA from one of the links below.
 
-The OVA is shipped as a bootstrapped Install Node.  It must be cloned multiple times to create as many Data Store Nodes as desired.
+The OVA is shipped as a bootstrapped install node.  It must be cloned multiple times to create as many Data Store Nodes as desired.
 
 ###### OVA Special Requirements
 * All nodes **MUST** be clones of the OVA.
@@ -104,10 +111,10 @@ The OVA is shipped as a bootstrapped Install Node.  It must be cloned multiple t
 Please see the [release page](https://github.com/EMCECS/ECS-CommunityEdition/releases) for OVA download links.
 
 #### [ECS Single-Node Deployment with Install Node (recommended)](docs/source/installation/ECS-Installation.md)
-Using an Install Node for isolated environments, deploy a stand-alone instance of ECS to a single hardware or virtual machine.
+Using an install node for isolated environments, deploy a stand-alone instance of ECS to a single hardware or virtual machine.
 
 #### [ECS Multi-Node Deployment with Install Node](docs/source/installation/ECS-Installation.md)
-Using an Install Node for isolated environments, deploy a multi-node ECS instance to two or more hardware or virtual machines.  Three nodes are required to enable erasure-coding replication.
+Using an install node for isolated environments, deploy a multi-node ECS instance to two or more hardware or virtual machines.  Three nodes are required to enable erasure-coding replication.
 
 
 # Directory Structure
@@ -207,3 +214,8 @@ EMC and Customer enter into this Agreement and this Agreement shall become effec
 **9.7 - Independent Contractors** - The parties shall act as independent contractors for all purposes under this Agreement. Nothing contained herein shall be deemed to constitute either party as an agent or representative of the other party, or both parties as joint venturers or partners for any purpose. Neither party shall be responsible for the acts or omissions of the other party, and neither party will have authority to speak for, represent or obligate the other party in any way without an authenticated record indicating the prior approval of the other party.
 
 **9.8 - Separability** - If any provision of this Agreement shall be held illegal or unenforceable, such provision shall be deemed separable from, and shall in no way affect or impair the validity or enforceability of, the remaining provisions.
+
+[ccoc]: https://github.com/EMCECS/ECS-CommunityEdition/blob/master/CODE_OF_CONDUCT.md
+[contributing]: https://github.com/EMCECS/ECS-CommunityEdition/blob/master/.github/CONTRIBUTING.md
+[releases]: https://github.com/EMCECS/ECS-CommunityEdition/releases
+[legacy_changelog]: https://github.com/EMCECS/ECS-CommunityEdition/blob/master/docs/legacy/changelog.md
diff --git a/README.rst b/README.rst
@@ -135,12 +135,12 @@ Deployments into Soft-Isolated and Air-Gapped Island Environments
 Important information regarding Island deployments
 ''''''''''''''''''''''''''''''''''''''''''''''''''
 
-Please be aware that Install Node bootstrapping requires Internet access
-to the hardware or virtual machine that will become the Install Node,
+Please be aware that install node bootstrapping requires Internet access
+to the hardware or virtual machine that will become the install node,
 but once this step is complete, the machine can be removed from the
 Internet and migrated into the Island environment.
 
-If you prefer to download a prefab Install Node as an OVF/OVA, follow
+If you prefer to download a prefab install node as an OVF/OVA, follow
 one of the links below. Please note that OVAs are produced upon each
 release and do not necessarily have the most current software.
 
@@ -149,15 +149,15 @@ Please see the `release page <https://github.com/EMCECS/ECS-CommunityEdition/rel
 `ECS Multi-Node Deployment with Install Node (recommended, most reusable, full-featured) <http://ecsce.readthedocs.io/en/latest/installation/ECS-Installation.html>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Using an Install Node for isolated environments, deploy a multi-node ECS
+Using an install node for isolated environments, deploy a multi-node ECS
 instance to two or more hardware or virtual machines and enable all ECS
 features. Three nodes are required for all ECS 3.0 and above features to
 be activated.
 
 `ECS Single-Node Deployment with Install Node <http://ecsce.readthedocs.io/en/latest/installation/ECS-Installation.html>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Using an Install Node for isolated environments, deploy a stand-alone
+Using an install node for isolated environments, deploy a stand-alone
 instance of a limited set of ECS kit to a single hardware or virtual
 machine.
 

diff --git a/changelog.rst b/changelog.rst
diff --git a/changelog.md → docs/legacy/changelog.md b/changelog.md → docs/legacy/changelog.md