Commit graph

21 commits

Author SHA1 Message Date
Vishal Gupta
f384888b6f metadata_azure: added tests and docs 2023-02-01 20:03:35 +05:30
Thomas Phipps
62c5619aba add metadata_gce grain to handle the fact that google is not
useing the ec2 format for their metadata servers anymore.

fixes #52332
2022-02-08 13:42:08 -08: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
piterpunk
c521f72d49 Added salt.grains.lvm to index.rst 2020-08-24 15:08:11 -07:00
piterpunk
deb2a310b0 Added "lvm" grain to list the LVM volumes
- LVM is an important information about a Linux machine.
  Usually Linux servers have most or all their disk
  filesystems using a logical volume as mountpoint.
- This initial support implements a grain called "lvm"
  which returns a dictionary with the volume groups, each
  one with a list of their logical volumes inside:

      VolumeGroup00:
          - LogicalVolume00
          - LogicalVolume01
          - ...
          - LogicalVolumeNN
      VolumeGroup01:
      ...
      VolumeGroupNN:
          - LogicalVolume00
          - LogicalVolume01
          - ...
          - LogicalVolumeNN
2020-08-24 15:08:11 -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
twangboy
adec0c81ea Add pending_reboot to toctree 2020-04-25 22:14:26 -07:00
twangboy
ea993e4b06 Add sphinx stub 2020-04-25 22:14:26 -07:00
Christian McHugh
ebf8417c61 Add max-arnold's tests and associated cleanup 2020-03-13 08:29:27 +00:00
Christian McHugh
b5d2e5a438 update for current state of master 2020-01-19 07:21:06 +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
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
Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
Nicole Thomas
7b1b06e327
Merge pull request #45528 from spenceation/panos-autodoc
Updating autodoc for PANOS modules.
2018-01-18 17:53:37 -05:00
Spencer Ervin
eae111739d Updating autodoc for CIMC modules. 2018-01-18 11:21:42 -05:00
Spencer Ervin
8b3a2014e1 Updating autodoc for PANOS modules. 2018-01-18 11:11:43 -05:00
Daniel Wallace
7b946e5fb9 add option required for metadata server grains 2016-11-17 10:12:43 -06:00
Mircea Ulinic
0ba8a2e5b9
Add NAPALM grains to docs 2016-10-27 15:50:46 +00: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
ca044dd201 Add grains modules to salt modindex
Fixes #28790
2016-02-02 13:35:49 -07:00