saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
120437 commits 34 branches 292 tags 803 MiB
Commit graph

63 commits

Author SHA1 Message Date
Pedro Algarvio
6c819439b5 Add a few more nice to have hooks 
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
 2023-02-07 07:10:13 +00:00
Elias Probst
a9fda57b73 doc: remove module suffix from descriptions 
Until now, the listings of all kinds of modules looked quite
inconsistent like this:
- salt.states.smtp
- salt.states.snapper module
- salt.states.solrcloud module
- salt.states.splunk

The `module` suffix is redundant anyways, so let's remove it and do some
further cleanup (adjusting overline/underline usage, underline length)
using the following bash script:

```bash

sed -i 's|\s\+module$||g' doc/ref/*/all/*.*.rst

for rst in doc/ref/*/all/*.*.rst;
do
  # enforce consistent overline/underline usage, remove all overlines
  if [[ $(head -n1 "${rst}") =~ ^=+$ ]];
  then
      sed -i -e 1d "${rst}"
  fi

  # adjust the length of the underline to the length of the module name
  module_name=$(head -n1 "${rst}")
  underline=$(for i in $(seq ${#module_name}); do echo -n "="; done)
  sed -i '2s|^=\+$|'"${underline}"'|g' "${rst}"
done
```
 2021-02-19 08:54:50 -05:00
Wesley Whetstone
1231b463f5 Revert "add plist to serializers doc index" 
This reverts commit 7512218a81.
 2020-05-19 10:16:07 -07:00
Wesley Whetstone
3615410955 add plist to serializers doc index 2020-05-19 10:16:07 -07:00
Alex Rothman
507998c1b0
Azure Blob ext_pillar (#55493) 
* Fixes #54374

* Added tests for #55493

* Fixes #54374

* Added tests for #55493

* Fixed lint issue

* Add pylint exception

* Fixes #54374

* Added tests for #55493

* Fixed lint issue

* Add pylint exception

* Blacken Salt

* Added sphinx stub

* Fixed sphinx stub

Co-authored-by: Akmod <tjohnson@saltstack.com>
Co-authored-by: Daniel Wozniak <dwozniak@saltstack.com>
 2020-04-26 20:50:13 -07:00
Christian McHugh
06ae428ced don't include unmerged nsot pillar 2020-01-19 07:40:39 +00:00
Megan Wilhite
d8b505ed2f Merge pull request #52368 from mchugh19/doc_tests 
Unit test to require execution module documentation
 2020-01-19 06:56:24 +00:00
rallytime
82e73fe49d
Merge branch '2018.3' into 'fluorine' 
Conflicts:
  - doc/ref/tops/all/index.rst
  - salt/fileclient.py
  - salt/grains/core.py
  - salt/modules/win_file.py
  - salt/pillar/__init__.py
  - salt/utils/http.py
 2018-10-18 10:41:42 -04:00
rallytime
1eaaab705f
Doc title formatting must match doc name length 2018-10-15 16:55:35 -04:00
Christian McHugh
6ac26b6c1e
add saltclass docs from release notes 2018-10-15 16:54:20 -04:00
Mircea Ulinic
7722544f92 Add netbox Pillar to autodoc 2018-08-03 10:38:53 +01:00
rallytime
ff277bc458 Add new documenation file references to build system for 2017.7 2017-06-16 21:17:33 +00:00
rallytime
3a232ffe8b Add autodoc modules for new files in nitrogen 2017-04-11 19:31:33 +00:00
rallytime
d398c5f7ee Update autodoc topics for new modules added in develop 
Also adjusted versionadded tags as necessary on the files that
are getting new autodoc files added.
 2017-02-02 10:12:58 -07:00
rallytime
b866427f59 Add a bunch of missing doc module references 
Also added an index.rst file for executors, renamed the
azurearm.rst file (Was misspelled with "azureare"), and
removed the xbps-pkg.rst file since that is an invalid
reference.
 2017-01-31 15:12:34 -07:00
rallytime
efb8a8ddf5 Merge branch '2016.3' into '2016.11' 
Conflicts:
  - doc/ref/configuration/minion.rst
  - salt/config/__init__.py
  - salt/minion.py
 2016-12-22 10:39:14 -07:00
Erik Johnson
27253522c8 Improve pillar documentation (#38407) 
* rename anchor

* Move pillar cache config option to different section, add an anchor

* Add links to master and minion config items

* Add documentation for pillar.item's "delimiter" argument

* Improve pillar documentation

This improves RST formatting, adding hyperlinks as well as adding
information on the difference between in-minion pillar data and
pillar data that is compiled on-demand.

* Add section on how pillar environments are handled
 2016-12-22 10:32:37 -07:00
Jacob Hammons
dd21da4992 Add autodoc topics for new modules added in Carbon (#36933) 
Module formatting issues
Add list of new Carbon modules to release notes
 2016-10-12 09:31:07 -06:00
rallytime
9d049e28e5 Merge branch '2016.3' into 'develop' 
Conflicts:
  - salt/modules/win_pkg.py
  - salt/states/disk.py
 2016-06-15 17:13:26 -06:00
Jacob Hammons
887a415138 Adds new Understanding Jinja topic, and fixes several Jinja doc issues. 
Removes the "Full list of builtin ..." from each module reference list, leaving just the module type for scanability.

Refs #12470
Refs #10206
Refs #10480
Refs #23522
Refs #33023
 2016-06-13 18:30:42 -06:00
Andrew Hammond
bc8f010489 add nodegroups ext_pillar (#33179) 
* add nodegroups ext_pillar

* nodegroups ext_pillar documentation tweaks

* put name in AUTHORS rather than directly in module
 2016-05-13 08:26:13 -06:00
Ryan Lane
9bf18083fb Confidant sdb and ext_pillar support (#32757) 
* Add an SDB module for confidant

* Add confidant external pillar

* Add docs
 2016-04-22 09:12:15 -06:00
Jacob Hammons
e48b84c98f Fixed build errors, additional mock imports, new module docs 
Fixes #31975
 2016-03-18 17:37:22 -06:00
Jacob Hammons
fd7f7bcddf Updated release notes 
Added a shortcut to link to pull requests
Added doc entries for all new modules
removed the unnecessary :undoc-members: option from recent doc module entries
 2016-03-14 16:34:22 -06:00
Jacob Hammons
2b7f96bf0e Fixed sphinx build warnings / errors, added autodoc entries for new modules added in Boron 2016-01-19 21:57:45 -07:00
Andrew Colin Kissa
61ca281519 fix inline documentation examples not rendering 
add missing modules to indexes
 2015-12-30 07:35:57 +02:00
Andrew Colin Kissa
b749b9faba Add Pillar SQLCipher module 
Fixes #29781
 2015-12-17 09:48:27 +02:00
Colton Myers
ec6cd80496 Merge remote-tracking branch 'upstream/2015.8' into merge-forward-develop 
Conflicts:
    doc/man/salt.7
    doc/ref/auth/all/index.rst
    doc/ref/auth/all/salt.auth.rest.rst
    doc/ref/beacons/all/index.rst
    doc/ref/beacons/all/salt.beacons.ps.rst
    doc/ref/pillar/all/index.rst
    doc/ref/pillar/all/salt.pillar.consul_pillar.rst
    doc/ref/pillar/all/salt.pillar.neutron.rst
    doc/ref/pillar/all/salt.pillar.sql_base.rst
    doc/ref/pillar/all/salt.pillar.sqlite3.rst
    doc/ref/sdb/all/salt.sdb.rest.rst
    salt/modules/rh_ip.py
    salt/utils/http.py
 2015-09-22 15:31:46 -06:00
Jacob Hammons
7ac98a03b6 Updated module doc index using https://github.com/saltstack/salt/pull/27203 2015-09-22 11:54:34 -06:00
Seth House
7422385e24 Add autosummary-generated docs 2015-07-17 17:53:16 -06:00
Seth House
1210a53685 Add all new modules to autosummary docs 2015-07-17 15:53:13 -06:00
Seth House
d844ca5112 Removed docs for ext_pillar module that is a wip 2015-05-01 14:24:01 -06:00
Seth House
4cb33c92d6 Added autodoc generated pages for the new modules types 2015-04-03 12:45:49 -06:00
Seth House
ef3893d4de Updated module index pages for each of the module types 2015-04-03 12:39:13 -06:00
Seth House
1399949196 Merge remote-tracking branch 'upstream/2015.2' into develop 2015-03-02 14:19:37 -07:00
Seth House
57b1f67daa Added autosummary generated placeholders for the new module docs 2015-03-02 14:07:18 -07:00
Seth House
1382401618 Updated all the module index pages with the latest/newest modules 2015-03-02 13:59:19 -07:00
Arnold Bechtoldt
73cbbf0e5f those files seem to be required, too 2015-01-24 21:51:45 +01:00
Arnold Bechtoldt
0ab5f51529 add missing file_tree and virtkey in pillar index doc, refs #19262 2015-01-24 21:43:32 +01:00
Thomas Jackson
2afd4c8c04 Whitespace cleanup 2014-12-11 07:53:19 -08:00
Nitin Madhok
c299f4119a Adding pillar to toctree 2014-12-08 10:52:38 -05:00
Michael Persson
5a3ddc3201 Add documentation link for Pepa 2014-09-11 10:30:17 +02:00
Seth House
6517e7f378 Added generated new module docs 2014-07-24 15:56:19 -06:00
Seth House
81af51bf50 Added new module docs 2014-07-24 15:28:11 -06:00
Arnold Bechtoldt
9a5ce71286 trying to add foreman pillar module to documentation, refs #13481 2014-06-17 19:24:27 +02:00
KennethWilke
bd18389507 moar docs, moar betta 2014-05-13 15:07:30 -05:00
Seth House
14515c3c8b Added generated templates for the new additions 2014-04-17 12:20:07 -06:00
Seth House
d2f057b0fd Combed through all the module types to add recent additions to the docs 2014-04-17 12:16:26 -06:00
Joseph Hall
cbe3060b6c Updating docs for etcd 2014-03-25 08:24:15 -06:00
Seth House
a719fec161 Added new/missing pillar modules 2013-10-15 16:00:02 -06:00