further lint fixes to docs
Change-Id: Id52501aaa528be216b4c7eb5b5bb71ed002feea1
diff --git a/docs/mdlstyle.rb b/docs/mdlstyle.rb
index f738818..ab3dc59 100644
--- a/docs/mdlstyle.rb
+++ b/docs/mdlstyle.rb
@@ -1,3 +1,21 @@
+# markdownlint(mdl) style rules
+# Rule descriptions:
+# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
+
+# Copyright 2017-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
# use all rules
all
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 0f0a09a..356b6fb 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -257,10 +257,12 @@
config` is run, the following steps happen:
1. The POD Config file is read, in this case
-[orchestration/profiles/rcord/podconfig/rcord-mock.yml](https://github.com/opencord/rcord/blob/{{ book.branch }}/podconfig/rcord-mock.yml),
-which specifies the scenario and profile.
+ [orchestration/profiles/rcord/podconfig/rcord-mock.yml](https://github.com/opencord/rcord/blob/{{
+ book.branch }}/podconfig/rcord-mock.yml), which specifies the scenario and
+ profile.
2. The Scenario config file is read, in this case
-[build/scenarios/mock/config.yml](https://github.com/opencord/cord/blob/{{ book.branch }}/scenarios/mock/config.yml).
+ [build/scenarios/mock/config.yml](https://github.com/opencord/cord/blob/{{
+ book.branch }}/scenarios/mock/config.yml).
3. The contents of these files are combined into a master config variable, with
the POD Config overwriting any config set in the Scenario.
4. The entire master config is written to `genconfig/config.yml`.
@@ -270,13 +272,12 @@
`genconfig/config.mk`. This sets the targets invoked by `make build`
Note that the combination of the POD and Scenaro config in step #3 is not a
-merge. If you define an item in the root of the POD Config that has subkeys,
-it will overwrite every subkey defined in the Scenario. This is most noticeable
-when setting the `inventory_groups` or `docker_image_whitelist`
-variable. If changing either in a POD Config, you must recreate the
-entire structure or list. This may seem inconvenient, but other list
-or tree merging strategies lack a way to remove items from a tree
-structure.
+merge. If you define an item in the root of the POD Config that has subkeys, it
+will overwrite every subkey defined in the Scenario. This is most noticeable
+when setting the `inventory_groups` or `docker_image_whitelist` variable. If
+changing either in a POD Config, you must recreate the entire structure or
+list. This may seem inconvenient, but other list or tree merging strategies
+lack a way to remove items from a tree structure.
## Build Process Overview
@@ -287,9 +288,9 @@
### `config` make target
`config` requires a `PODCONFIG` argument, which is the name of a file in
-`orchestration/profiles/<use-case>/podconfig/`. `PODCONFIG` defaults to `invalid`, so if you get errors
-claiming an invalid config, you probably didn't set it, or set it to a filename
-that doesn't exist.
+`orchestration/profiles/<use-case>/podconfig/`. `PODCONFIG` defaults to
+`invalid`, so if you get errors claiming an invalid config, you probably didn't
+set it, or set it to a filename that doesn't exist.
#### Examples: `make config`