diff --git a/.travis.yml b/.travis.yml index b0c6c21c..6ab06f01 100644 --- a/.travis.yml +++ b/.travis.yml @@ -45,6 +45,12 @@ jobs: - go get github.com/myii/maintainer - maintainer contributor + # Update Tables of Content in the relevant `.md` files + - npm install markdown-toc -D + - markdown-toc -i CONTRIBUTING.md + # - markdown-toc -i README.md + - markdown-toc -i TOFS_pattern.md + # Install all dependencies required for `semantic-release` - npm install @semantic-release/changelog@3 -D - npm install @semantic-release/exec@3 -D diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26f43cbe..3919bcd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,10 @@ # How to contribute +
Table of Contents
+ + +
+ ## Commit message formatting ### Automation of multiple processes diff --git a/README.rst b/README.rst index db46bdb2..f679e303 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,8 @@ template-formula A SaltStack formula that is empty. It has dummy content to help with a quick start on a new formula and it serves as a style guide. +.. contents:: **Table of Contents** + **NOTE** See the full `Salt Formulas installation and usage instructions diff --git a/TOFS_pattern.md b/TOFS_pattern.md index 4ecb31dd..c133e91d 100644 --- a/TOFS_pattern.md +++ b/TOFS_pattern.md @@ -7,6 +7,11 @@ Modified by Daniel Dehennin All that follows is a proposal based on my experience with [Saltstack](http://www.saltstack.com/). The good thing of a piece of software like this is that you can "bend it" to suit your needs in many possible ways, and this is one of them. All the recommendations and thoughts are given "as it is" with no warranty of any type. +
Table of Contents
+ + +
+ ## Usage of values in pillar vs templates in file_roots