Skip to content

Commit

Permalink
docs: fix whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
dafyddj committed Jul 27, 2020
1 parent 01fd4e6 commit d98d98f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 20 deletions.
34 changes: 17 additions & 17 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -821,20 +821,20 @@ BREAKING CHANGES
^^^^^^^^^^^^^^^^


*
*
**tofs:** every formula writer will need to change the import
to use this new version.

*
*
template/libtofs.jinja: provides the “files_switch” macro.

*
*
docs/TOFS_pattern.rst: update documentation to use the new path.

*
*
template/config/clean.sls: change import from “macros.jinja” to “libtofs.jinja”.

*
*
template/config/file.sls: ditoo.

`1.2.6 <https://github.com/saltstack-formulas/template-formula/compare/v1.2.5...v1.2.6>`_ (2019-03-24)
Expand Down Expand Up @@ -1292,7 +1292,7 @@ Other


* Updated changelog and version. [Alexander Weidinger]
*
*
Map.jinja: use grains.filter_by instead of defaults.merge. [Alexander Weidinger]

because defaults.merge does not work with salt-ssh. https://github.com/saltstack/salt/issues/51605
Expand All @@ -1317,7 +1317,7 @@ Other
----------------------------------------------------------------------------------------------------------


*
*
Examples must be consistent. [Daniel Dehennin]

The “template” is kept during rendering.
Expand All @@ -1326,7 +1326,7 @@ Other
* TOFS_pattern.md: add “template” to rendered state.
* template/macros.jinja: ditoo.

*
*
Remove double slash in generated salt URL. [Daniel Dehennin]

When the files are “full path” with leading slash “/”, the generated URL contain a double slash because of the join.
Expand All @@ -1335,30 +1335,30 @@ Other
* template/macros.jinja: remove leading slash before joining parts.
* TOFS_pattern.md: mirror changes of “macros.jinja”.

*
*
Add an example for “ntp” of the use of “files_switch” [Daniel Dehennin]

*
*
Accept pillar separator in “files_switch” prefix. [Daniel Dehennin]

The prefix was used for 2 purposes:


* define the pillar prefix where to lookup “:files_switch”. It supports the colon “:” separator to lookup in pillar subtree like “foo:bar”
*
*
define the path prefix where to look for “files/”, It did not support separator to lookup inside directory tree.

This patch only replace any colon “:” with “/” when looking up “files/” directory, with the “foo:bar” prefix:

*
*
lookup “foo:bar:files_switch” pillar to get list of grains to match

* lookup files under “salt://foo/bar/files/”
* TOFS_pattern.md: document the new use of “prefix” supporting colon “:”.
* template/macros.jinja: transform any colon “:” in “prefix” by slash
“/” to lookup files.

*
*
Make TOFS pattern example usable. [Daniel Dehennin]

The example could not be used as-is. This commit improve conformity to formula conventions.
Expand All @@ -1367,14 +1367,14 @@ Other
* TOFS_pattern.md: add missing commas “,” in “map.jinja” and extra one
to ease the addition of new entries. Import “map.jinja” in “init.sls” and “conf.sls”. Declare descriptive state IDs. Use the “module.function” notation. Use the “name” parameter.

*
*
Cosmetics modification of TOFS pattern documentation. [Daniel Dehennin]


* TOFS_pattern.md: add myself as modifier.
Trim trailing whitespaces. Separate titles from first paragraph.

*
*
Switch template.config to TOFS pattern. [Daniel Dehennin]

* Import TOFS pattern from Zabbix formula. [Daniel Dehennin]
Expand Down Expand Up @@ -1413,12 +1413,12 @@ Other

* Change states to use short-dec style. [Seth House]
* Update CHANGELOG.rst. [Nitin Madhok]
*
*
Update README.rst. [Nitin Madhok]

Fix broken link

*
*
Fixing pillar to match the map file. [Forrest]

Map file and pillar didn't match.
Expand Down
1 change: 0 additions & 1 deletion docs/CONTRIBUTING_DOCS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,3 @@ we are using for some of the pages of this documentation.
Obviously, it is not necessary to follow the steps in the order above.
For example, it is usually easier to write the ``[Introductory paragraph]``
at the end.

1 change: 0 additions & 1 deletion docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,4 +201,3 @@ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``veri
^^^^^^^^^^^^^^^^^^^^^

Gives you SSH access to the instance for manual testing.

1 change: 0 additions & 1 deletion docs/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@
{
overflow: visible !important;
}

0 comments on commit d98d98f

Please sign in to comment.