Update CSE main documentation (vmware#140)

Fixed markdown display issues, such as invalid tables and extra asterisks. Fixed broken link (CONTRIBUTING.md).
andrew-ni · Nov 1, 2018 · f4f48a7 · f4f48a7
1 parent 22937df
commit f4f48a7
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ See our [site](https://vmware.github.io/container-service-extension/).
 
 ## Contributing
 
-The *container-service-extension* project team welcomes contributions from the community. Before you start working with *container-service-extension*, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+The *container-service-extension* project team welcomes contributions from the community. Before you start working with *container-service-extension*, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](docs/CONTRIBUTING.md).
 
 ## License
 

diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
@@ -1,5 +1,5 @@
-# __**CSE Contributing Guide**__
-[back to main CSE page](docs/README.md#contributing)
+# **CSE Contributing Guide**
+[back to main CSE page](README.md#contributing)
 
 Commits should follow this guide: https://chris.beams.io/posts/git-commit/
 
@@ -25,7 +25,7 @@ Community: https://vmwarecode.slack.com  #vcd (channel)
 - [CSE Usage and Testing](#usage)
 - [Standard Git Workflow](#git)
 
-## [__**Python**__](#toc) <a name="python"></a>
+## [**Python**](#toc) <a name="python"></a>
 - Install Python 3.6 or greater (https://realpython.com/installing-python/)
 - Install pip (Python's package manager)
 
@@ -39,7 +39,7 @@ Python 3.7.0
 pip 18.0 from /usr/local/lib/python3.7/site-packages/pip (python 3.7)
 ```
 ---
-## [__**Virtual Environments**__](#toc) <a name="virtualenvs"></a>
+## [**Virtual Environments**](#toc) <a name="virtualenvs"></a>
 A virtual environment is a project workspace (a folder/directory) where your project's dependencies are isolated from the user/global space and from the dependencies of other projects. For example, if one project you're working on requires Flask 1.0 and another project requires Flask 2.0, these projects have different dependencies, and without virtual environments, you can't have both Flask 1.0 and 2.0. Having a virtual environment for each project will allow you to develop and test both of these projects on one machine.
 
 The virtual environment program we will use is [`virtualenv`](https://virtualenv.pypa.io/en/stable/), though there are others that do the same thing, such as `pipenv`, `conda`, `venv`, etc. The program [`virtualenvwrapper`](https://virtualenvwrapper.readthedocs.io/en/latest/) includes a lot of helpful shortcuts/functionality for managing your virtual environments, and using it is personal preference.
@@ -87,7 +87,7 @@ More on virtual environments:
 - https://www.geeksforgeeks.org/python-virtual-environment/
 - https://realpython.com/python-virtual-environments-a-primer/
 ---
-## [__**Project Setup**__](#toc) <a name="projectsetup"></a>
+## [**Project Setup**](#toc) <a name="projectsetup"></a>
 
 ### **Git Setup**
 - VMware CSE repository (https://github.com/vmware/container-service-extension) is the **upstream** remote repository
@@ -147,7 +147,7 @@ wheel                       0.32.1
 ![cse-workflow](img/cse-workflow-2.png) <a name="cseworkflow"></a>
 
 ---
-## [__**CSE Usage and Testing**__](#toc) <a name="usage"></a>
+## [**CSE Usage and Testing**](#toc) <a name="usage"></a>
 
 ### **Configure vcd-cli to enable `vcd cse ...` commands**
 Edit `~/.vcd-cli/profiles.yaml` to include this section:
@@ -234,7 +234,7 @@ If `~/.vcd-cli/profiles.yaml` doesn't exist, logging in to vCD via **vcd-cli** w
 > vcd cse cluster delete mycluster
 ```
 ---
-## [__**Standard Git Workflow**__](#toc) <a name="git"></a>
+## [**Standard Git Workflow**](#toc) <a name="git"></a>
 - Never push to **upstream master**
 - Check if upstream master has any updates
     - if it does, pull these changes into your local project's master branch, then push these changes to update your remote origin master branch

diff --git a/docs/NFS_STATIC_PV.md b/docs/NFS_STATIC_PV.md
@@ -1,4 +1,4 @@
-# __**CSE: NFS-based Static Persistent Volumes**__
+# **CSE: NFS-based Static Persistent Volumes**
 [back to main CSE page](README.md#nfs)
 
 CSE now enables users to deploy stateful applications on vCD Kubernetes clusters by leveraging static persistent volumes backed by an NFS server.

diff --git a/docs/README.md b/docs/README.md
@@ -27,7 +27,7 @@ Container Service Extension (CSE) is a VMware vCloud Director extension that hel
 
 ---
 ---
-# [__**Overview**__](#toc) <a name="overview"></a>
+# [**Overview**](#toc) <a name="overview"></a>
 
 CSE brings Kubernetes as a service to vCD by creating customized VM templates and enabling tenant/organization administrators to deploy fully functional Kubernetes clusters.
 
@@ -40,7 +40,7 @@ Once CSE Server is running and VM templates are available, **tenant/organization
 
 ---
 ---
-# [__**Getting CSE**__](#toc) <a name="gettingcse"></a>
+# [**Getting CSE**](#toc) <a name="gettingcse"></a>
 
 Install Python 3.6 or greater. Pip, Python's package manager, should come with Python.
 - https://realpython.com/installing-python/
@@ -75,7 +75,7 @@ All CSE versions on GitHub: https://github.com/vmware/container-service-extensio
 
 ---
 ---
-# [__**Enabling CSE Client Commands in vcd-cli**__](#toc) <a name="enableclient"></a>
+# [**Enabling CSE Client Commands in vcd-cli**](#toc) <a name="enableclient"></a>
 
 CSE client is not enabled yet:
 ```sh
@@ -104,13 +104,13 @@ CSE, Container Service Extension for VMware vCloud Director, version 1.2.0
 ```
 ---
 ---
-# [__**System/Cloud Administrator**__](#toc) <a name="sysadmin"></a>
+# [**System/Cloud Administrator**](#toc) <a name="sysadmin"></a>
 
 ## [**CSE/vCD Compatibility**](#toc) <a name="compatibility"></a>
-| CSE version     | vCD version                |
-|:--------|:---------------------|
-| 1.1.0   | 8.20, 9.0, 9.1       |
-| 1.2.0   | 8.20, 9.0, 9.1, 9.5 |
+| CSE version | vCD version         |
+|-------------|---------------------|
+| 1.1.0       | 8.20, 9.0, 9.1      |
+| 1.2.0       | 8.20, 9.0, 9.1, 9.5 |
 
 ---
 ## [**Config File**](#toc) <a name="configfile"></a>
@@ -123,14 +123,14 @@ Edit this file with values from your vCloud Director
 <br>
 
 Config file has 5 sections: `amqp`, `vcd`, `vcs`, `service`, `broker`
-### **`amqp` section**
+### **amqp** section
 CSE Server will communicate with vCD using these settings
 
 During CSE Server installation, CSE can configure vCD's AMQP settings to match these settings
 
 <br>
 
-### **`vcd` section**
+### **vcd** section
 It's recommended to create a service account for vCD with minimum required privileges. An attacker getting credentials for a user account with admin-level privileges can be catastrophic
 
 Minimum roles and (admin-view) rights required for the service account (subject to change with new vCD versions):
@@ -172,7 +172,7 @@ Always ensure vCD service account has enough privileges. Alternatively, you can
 
 <br>
 
-### **`vcs` section**
+### **vcs** section
 Guest Operations Privileges required for vCenter service account:
 - Guest Operation Program Execution
 - Guest Operation Modifications
@@ -190,12 +190,12 @@ Each `vc` under `vcs` section has the following properties:
 
 <br>
 
-### **`service` section**
+### **service** section
 Specify how many threads you want CSE Server to create.
 
 <br>
 
-### **`broker` section**
+### **broker** section
 `broker` section has the following properties:
 
 | Property           | Value                                                                                                                                                                                                                |
@@ -232,8 +232,9 @@ Each `template` in the `templates` property has the following properties:
 `CSE` supports multiple VM templates to create Kubernetes clusters from. Templates may vary in guest OS or software versions, and must have a unique name. One template must be defined as the default template, and tenants have the option to specify the template to use during cluster/node creation.
 
 ### **Source .ova Files for VM Templates**
+
 | OS                   | OVA Name                               | URL                                                                                                       | SHA256                                                           |
-|:----------------------|:----------------------------------------|:-----------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------|
+|----------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
 | Photon OS 1.0, Rev 2 | photon-custom-hw11-1.0-62c543d.ova     | `https://bintray.com/vmware/photon/download_file?file_path=photon-custom-hw11-1.0-62c543d.ova`            | 6d6024c5531f5554bb0d2f51f3005078ce6d4ee63c142f2453a416824c5344ca |
 | Photon OS 2.0 GA     | photon-custom-hw11-2.0-304b817.ova     | `http://dl.bintray.com/vmware/photon/2.0/GA/ova/photon-custom-hw11-2.0-304b817.ova`                       | cb51e4b6d899c3588f961e73282709a0d054bb421787e140a1d80c24d4fd89e1 |
 | Ubuntu 16.04.4 LTS   | ubuntu-16.04-server-cloudimg-amd64.ova | `https://cloud-images.ubuntu.com/releases/xenial/release-20180418/ubuntu-16.04-server-cloudimg-amd64.ova` | 3c1bec8e2770af5b9b0462e20b7b24633666feedff43c099a6fb1330fcc869a9 |
@@ -501,7 +502,7 @@ pip3 install --user --upgrade container-service-extension
 ```
 ---
 ---
-# [__**Tenant/Organization Administrator and Other Users**__](#toc) <a name="otherusers"></a>
+# [**Tenant/Organization Administrator and Other Users**](#toc) <a name="otherusers"></a>
 Once CSE Server is installed and running, tenants can use CSE client ([vcd-cli](https://vmware.github.io/vcd-cli)) to create Kubernetes clusters on demand.
 
 Master and worker nodes are VMs within a vApp on the tenant virtual datacenter. The VMs are required to be connected to an organization VDC network specified with the `--network` required command-line option. This network should have a static IP pool, and may require access to the internet if installing additional components.
@@ -629,7 +630,7 @@ client.logout()
 ```
 ---
 ---
-# [__**NFS-based Static Persistent Volumes**__](#toc) <a name="nfs"></a>
+# [**NFS-based Static Persistent Volumes**](#toc) <a name="nfs"></a>
 
 [Link](NFS_STATIC_PV.md)
 
@@ -714,12 +715,12 @@ Currently, NFS servers in Kubernetes cluster can not only be accessed by nodes o
 
 ---
 ---
-# [__**Contributing Guide**__](#toc) <a name="contributing"></a>
+# [**Contributing Guide**](#toc) <a name="contributing"></a>
 
-[Link](../CONTRIBUTING.md)
+[Link](CONTRIBUTING.md)
 
 ---
 ---
-# [__**Release Notes**__](#toc) <a name="releasenotes"></a>
+# [**Release Notes**](#toc) <a name="releasenotes"></a>
 
 [Link](RELEASE_NOTES.md)
diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -1,4 +1,4 @@
-# __**CSE Release Notes**__
+# **CSE Release Notes**
 [back to main CSE page](README.md#releasenotes)
 ### CSE 1.1.0