[CORD-3038]v2 Ignore more files so docs lint, minor fixes
Change-Id: Iab254df5b4492014cddde43802bd0f962c7e6e8d
diff --git a/.gitignore b/.gitignore
index c19a678..e2b9ee5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,5 +4,7 @@
# https://github.com/GitbookIO/gitbook/issues/1845
npm-debug.log
-_book/
-node_modules/
+node_modules
+_book
+xos/_book
+venv-xosdocs
diff --git a/README.md b/README.md
index 92d7b42..94208cb 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# OpenCord Introduction
+# Introduction to CORD
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quod ducimus impedit
quidem sapiente necessitatibus quo hic ut! Fugit ut sed sapiente maiores
diff --git a/charts/helm.md b/charts/helm.md
index 0a0e3c9..50bd961 100644
--- a/charts/helm.md
+++ b/charts/helm.md
@@ -16,9 +16,9 @@
git clone https://gerrit.opencord.org/helm-charts
```
-> If you have downloaded the CORD code following the
-[Getting the Source Code](../developer/getting_the_code.md) guide,
-you'll find it in `~/cord/helm-charts`.
+> If you have downloaded the CORD code following the [Getting the Source
+> Code](../developer/getting_the_code.md) guide, you'll find it in
+> `~/cord/helm-charts`.
### Add the CORD repository to helm (NOT YET AVAILABLE)
@@ -38,4 +38,4 @@
```shell
helm install --name cord-kafka incubator/kafka -f examples/kafka-single.yaml
-```
\ No newline at end of file
+```
diff --git a/developer/workflows.md b/developer/workflows.md
index 36e989a..44acc4e 100644
--- a/developer/workflows.md
+++ b/developer/workflows.md
@@ -107,4 +107,4 @@
you can find more informations about what a
docker-registry is [here](../prereqs/docker-registry.md).
-{% include "/partials/push-images-to-registry.md" %}
\ No newline at end of file
+{% include "/partials/push-images-to-registry.md" %}
diff --git a/partials/push-images-to-registry.md b/partials/push-images-to-registry.md
index 8a91498..0b8e1f4 100644
--- a/partials/push-images-to-registry.md
+++ b/partials/push-images-to-registry.md
@@ -20,6 +20,7 @@
```
> NOTE: you can do that using the `docker tag` command:
+>
> ```shell
> docker tag xosproject/vsg-synchronizer:candidate 192.168.10.12:30500/xosproject/vsg-synchronizer:candidate
-> ```
\ No newline at end of file
+> ```
diff --git a/prereqs/docker-registry.md b/prereqs/docker-registry.md
index c523ce0..6b4494f 100644
--- a/prereqs/docker-registry.md
+++ b/prereqs/docker-registry.md
@@ -34,4 +34,4 @@
## Push the images to the docker registry
-{% include "/partials/push-images-to-registry.md" %}
\ No newline at end of file
+{% include "/partials/push-images-to-registry.md" %}
diff --git a/prereqs/helm.md b/prereqs/helm.md
index 630980e..788d0d5 100644
--- a/prereqs/helm.md
+++ b/prereqs/helm.md
@@ -6,19 +6,19 @@
## How to install helm
-The full instructions and basic commands to get started
-with helm can be found here: <https://docs.helm.sh/using_helm/#quickstart>
+The full instructions and basic commands to get started with helm can be found
+here: <https://docs.helm.sh/using_helm/#quickstart>
-For simplicity here are are few commands that you can use to install `helm`
-on your sistem:
+For simplicity here are are few commands that you can use to install `helm` on
+your system:
-#### macOS
+### macOS
```shell
brew install kubernetes-helm
```
-#### Linux
+### Linux
```shell
wget https://storage.googleapis.com/kubernetes-helm/helm-v2.9.1-linux-amd64.tar.gz
@@ -26,14 +26,14 @@
mv linux-amd64/helm /usr/local/bin/helm
```
-#### Initialize helm and setup Tiller
+### Initialize helm and setup Tiller
```shell
helm init
```
-Once `helm` is installed you should be able
-to run the command `helm list` without errors
+Once `helm` is installed you should be able to run the command `helm list`
+without errors
## What is an helm chart?
@@ -49,4 +49,4 @@
- [voltha](../charts/voltha.md)
You can find the full chart documentation here:
-<https://docs.helm.sh/developing_charts/#charts>
\ No newline at end of file
+<https://docs.helm.sh/developing_charts/#charts>