a9fda57b73
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
```
|
||
|---|---|---|
| .github | ||
| .pre-commit-hooks | ||
| changelog | ||
| cicd | ||
| conf | ||
| doc | ||
| pkg | ||
| requirements | ||
| rfcs | ||
| salt | ||
| scripts | ||
| tasks | ||
| templates | ||
| tests | ||
| .codeclimate.yml | ||
| .codecov.yml | ||
| .coveragerc | ||
| .editorconfig | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .mention-bot | ||
| .pre-commit-config.yaml | ||
| .pylintrc | ||
| .rstcheck.cfg | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.rst | ||
| DEPENDENCIES.md | ||
| Gemfile | ||
| kitchen.yml | ||
| LICENSE | ||
| MANIFEST.in | ||
| noxfile.py | ||
| pyproject.toml | ||
| pytest.ini | ||
| README.rst | ||
| SECURITY.md | ||
| setup.py | ||
| SUPPORT.rst | ||
- Latest Salt Documentation
- Open an issue (bug report, feature request, etc.)
Salt is the world’s fastest, most intelligent and scalable automation engine.
About Salt
Built on python, Salt uses simple and human-readable YAML combined with event-driven automation to deploy and configure complex IT systems. In addition to leveling-up vRealize Automation SaltStack Config, Salt can be found under the hood of products from Juniper, Cisco, Cloudflare, Nutanix, SUSE, and Tieto, to name a few.
About SaltStack
SaltStack was acquired by VMware in 2020. Salt Project remains an open source ecosystem that VMware supports and contributes to.
Download Salt
Salt is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu, MacOS, Windows, and more. Download Salt and get started now.
Salt Project Documentation
Installation instructions, getting started guides, in-depth API documentation, and contributing to Salt.
Security Advisories
Keep an eye on the Salt Project Security Announcements landing page. Salt Project recommends subscribing to the Salt Project Security RSS feed to receive notification when new information is available regarding security announcements.
Other channels to receive security announcements include the Salt Community mailing list and the Salt Community Slack Channel.
Responsibly Reporting Security Vulnerabilities
When reporting security vulnerabilities for Salt or other SaltStack projects, refer to the SECURITY.md file found in this repository.
Engage the Salt Project and The Community
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:
- Salt Project Community Wiki
- Salt Project Community Slack
- Salt Project: IRC on Freenode
- Salt Project YouTube channel
- Salt Project Twitch channel
There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Project Community Events Calendar on the main https://saltproject.io website.
If you have additional questions, email us at core@saltstack.com or reach out directly to the Community Manager, Janae Andrus via Slack. We’d be glad to have you join our community!
License
Salt is licensed under the Apache 2.0 license. Please see the LICENSE file for the full text of the Apache license, followed by a full summary of the licensing used by external modules.
A complete list of attributions and dependencies can be found here: salt/DEPENDENCIES.md