Commit graph

118 commits

Author SHA1 Message Date
Daniel A. Wozniak
179e95fa89 docs fixup 2024-04-11 16:22:55 -07:00
Pedro Algarvio
3b24505b3a Remove deprecated code 2024-02-07 08:51:31 +00:00
faivirol
0ab0177629 update 2023-05-31 19:00:56 +00:00
faivirol
a0ca327de7 Clarify that it is execution modules that sync returners 2023-05-31 19:00:56 +00:00
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
Pedro Algarvio
5e72e192f9 Blacken docs 2020-06-09 03:37:02 -07: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
Erik Johnson
92e7a6f31f Add docs stubs for appoptics_return 2020-04-17 21:31:12 -05:00
Christian McHugh
9de8f25e31 don't include unmerged appoptics returner 2020-01-19 07:42:25 +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
Dmitry Kuzmenko
3d44f2c958
Merge branch 'master' into port-51949 2019-11-06 11:13:13 +03:00
Pedro Algarvio
b8c2e75cf1
Update docs for the configurable branch 2019-10-25 18:29:42 +01:00
Gareth J. Greenaway
0c251cf919 Merge pull request #51996 from mchugh19/remove_hipchat
Add release note about hipchat removal
2019-10-13 09:28:52 +01:00
Ch3LL
63962b547a
Merge branch '2018.3' into '2019.2'
Conflicts:
  - salt/states/linux_acl.py
  - salt/transport/ipc.py
2019-03-28 11:10:45 -04:00
Alan Cugler
0b1eb00dc4
Replaced test.ping with test.version
Result of issue #52277

Any where `test.ping` still exists in the docs was left
because of the context in those docs.
2019-03-25 12:09:48 -05:00
Gareth J. Greenaway
e37fc20e7c
Merge branch '2018.3' into merge-2018.3
Conflicts:
  - doc/ref/modules/all/index.rst
  - salt/states/file.py
  - tests/unit/modules/test_yumpkg.py
  - tests/unit/modules/test_zypperpkg.py
  - tests/unit/states/test_file.py
2019-02-22 16:38:15 -08:00
Daniel Wallace
33bb5bfe69
fix use of virtualname
Make sure that the virtualname is included in the actual filename of
core modules.  This will help speed up loading of modules that need to
use the virtualname, so that we hit @depends decorators less.
2019-02-19 13:16:06 -06:00
rallytime
26ef48814e
Merge branch '2018.3' into 'fluorine'
Conflicts:
  - salt/modules/virt.py
  - tests/integration/shell/test_matcher.py
2018-08-07 11:00:42 -04:00
Daniel Wallace
60661b4cd0
document minions required on save_load 2018-07-06 10:01:11 -05:00
rallytime
7dc1e770c4
Merge branch '2018.3' into 'develop'
Conflicts:
  - doc/topics/installation/freebsd.rst
  - salt/cloud/clouds/oneandone.py
  - salt/grains/core.py
  - salt/modules/napalm_ntp.py
  - salt/modules/win_update.py
  - salt/modules/win_wua.py
  - salt/modules/zabbix.py
  - salt/renderers/pass.py
  - salt/states/vault.py
  - tests/unit/states/test_win_update.py
2018-06-06 13:35:36 -04:00
rallytime
3273bbdab7
Merge branch '2017.7' into '2018.3'
Conflicts:
  - doc/ref/configuration/master.rst
  - doc/ref/modules/all/index.rst
  - doc/topics/grains/index.rst
  - doc/topics/releases/2016.3.4.rst
  - doc/topics/spm/spm_formula.rst
  - doc/topics/tutorials/cron.rst
  - doc/topics/tutorials/index.rst
  - doc/topics/tutorials/stormpath.rst
  - salt/engines/slack.py
  - salt/log/handlers/fluent_mod.py
  - salt/modules/cyg.py
  - salt/modules/junos.py
  - salt/modules/namecheap_dns.py
  - salt/modules/namecheap_domains.py
  - salt/modules/namecheap_ns.py
  - salt/modules/namecheap_ssl.py
  - salt/modules/namecheap_users.py
  - salt/modules/reg.py
  - salt/modules/tomcat.py
  - salt/modules/vault.py
  - salt/modules/win_file.py
  - salt/modules/zpool.py
  - salt/output/highstate.py
  - salt/renderers/pass.py
  - salt/runners/cache.py
  - salt/states/boto_apigateway.py
  - salt/states/boto_iam.py
  - salt/states/boto_route53.py
  - salt/states/msteams.py
  - salt/states/reg.py
  - salt/states/win_iis.py
  - tests/integration/modules/test_cmdmod.py
  - tests/integration/states/test_user.py
  - tests/support/helpers.py
  - tests/unit/cloud/clouds/test_openstack.py
  - tests/unit/fileserver/test_gitfs.py
  - tests/unit/modules/test_junos.py
  - tests/unit/pillar/test_git.py
  - tests/unit/states/test_win_path.py
  - tests/unit/test_pillar.py
  - tests/unit/utils/test_format_call.py
  - tests/unit/utils/test_utils.py
  - tests/unit/utils/test_warnings.py
2018-06-01 14:54:12 -04:00
Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
rallytime
757a662b16
Merge branch 'oxygen' into 'develop'
Conflicts:
  - tests/unit/grains/test_core.py
2017-12-30 08:49:21 -05:00
Erik Johnson
7b13a7df8b
Replace json module usage with a helper to ensure unicode content is handled properly
This adds wrappers for json.dump{,s} which disable `ensure_ascii` by
default.
2017-12-27 09:30:58 -06:00
Andrew Dampf
b11af1d969
typo 2017-12-13 10:43:49 -05:00
Tyler Jones
9af65b6af2
fixing virtualname, and other small fixes 2017-11-14 01:35:16 +00:00
Roald Nefs
1cd784300f
Add Telegram returner
Added Telegram returner and made a reference to the returner in
the documentation
2017-10-18 12:38:05 +02:00
Seth House
f1dc63f16c Add performance expectations and recommendations to rest_cherrypy docs 2017-05-12 17:57:32 -06:00
Enquier
b81856e370 Reordering Write Returners documentation 2017-04-19 14:49:28 -06:00
Jonathan Mickle
6b52e5a0b9 updating documentation for librato returner 2017-03-09 10:04:46 -08:00
rallytime
609e6e4b23 Merge branch '2016.11' into 'develop'
Conflicts:
  - salt/config/__init__.py
  - salt/modules/win_lgpo.py
  - salt/utils/aws.py
  - tests/unit/utils/schema_test.py
2017-02-09 10:29:40 -07:00
rallytime
2f74dcf685 Various doc updates to fix warnings in doc build 2017-02-06 16:56:58 -07: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
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
6464236f68 Merge branch '2016.3' into 'develop'
Conflicts:
  - doc/conf.py
  - doc/ref/returners/index.rst
  - salt/states/disk.py
2016-08-25 16:09:01 -06:00
Nicole Thomas
cd90052187 Documentation spelling fixes (#35773)
Fixes #35771
2016-08-25 13:41:03 -06:00
Mike Place
4fe3397a41 Merge pull request #34921 from tonybaloney/quickstart
Introduce a template system for extending SaltStack open
2016-07-28 22:38:10 -06:00
Mike Place
404833e51b Merge pull request #34969 from fdamstra/Add_multi_event_return
Adds support for multiple server-side event_returners.
2016-07-28 13:39:52 -06:00
Anthony Shaw
5b2a97e22b
added docs 2016-07-28 11:33:42 +10:00
Fred Damstra
8b56d76490 Adds support for multiple server-side event_returners.
The master config 'event_return' can now take a list
of returners which will each be called in turn. It
continues to function with the previous configuration
format of a single item.
2016-07-27 11:41:59 -04:00
Fred Damstra
d75276f9d9 Added documentation link for rawfile_json returner. 2016-07-13 20:34:27 -04: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
rallytime
d684d49490 Merge branch '2016.3' into 'develop'
Conflicts:
  - doc/topics/releases/2015.5.10.rst
  - doc/topics/releases/2015.8.8.rst
2016-03-28 11:16:22 -06:00
rallytime
7554d0f42d Merge branch '2015.5' into '2015.8'
Conflicts:
  - doc/ref/states/include.rst
  - doc/topics/cloud/reactor.rst
  - doc/topics/reactor/index.rst
  - doc/topics/releases/2015.5.10.rst
  - doc/topics/tutorials/states_pt5.rst
  - doc/topics/windows/windows-package-manager.rst
  - salt/config.py
  - salt/modules/state.py
  - salt/states/grains.py
  - tests/integration/modules/sysmod.py
  - tests/unit/states/grains_test.py
2016-03-24 15:48:00 -06:00
Erik Johnson
1b97e4a3df Improve state module docs, replace references to state.highstate/state.sls with state.apply
Resolves #32037.
2016-03-21 22:56:17 -05:00
Jacob Hammons
e48b84c98f Fixed build errors, additional mock imports, new module docs
Fixes #31975
2016-03-18 17:37:22 -06:00