Repository files navigation

If you're looking to learn about Salt, you've come to the right place.

• View the Sphinx-built documentation here
• View the source repo here

The Salt User Guide supplements and extends the core documentation for theSalt Project. This guide is intended tohelp Salt users learn about Salt's core concepts and features. It was originallyauthored by Alan Cugler and reviewed as a cross-collaborative effort betweenmany Salt experts.

Contributions from anyone inside the Salt project community are always welcome.Please read theContributing to Salt documentation formore information.

Check out the following links related to the Salt User Guide:

• Salt Project: The repository for theSalt Project.
• Salt Project Home Page: The web portal forSalt community events and resources.
• Contributing Guide:For information about contributing to the Salt User Guide and other Saltdocumentation projects, including how to set up your environment and otherpolicies around submitting merge requests or issues.
• Salt Style Guide:For general guidance about using Salt Project terms and other style orformatting conventions.
• Writing Salt documentation (rST guide):For conventions and guidelines about formatting reStructured Text (rST) inSalt documentation.

The following documentation is part of the Salt Project documentation:

• Salt Install Guide:This guide provides instructions for installing Salt on Salt supported operatingsystems. It also explains how to configure Salt, start Salt services, and verifyyour installation.
• Salt Project documentation:Includes the full documentation for the Salt Project.
• Module documentation:The Salt modules and state modules explain the use cases and arguments neededto execute the Salt modules.

This repository uses the following tools:

• The Salt User Guide documentation is composed inreStructured text (rST),which is a version of Markdown that is generally used in Python-based projects.
• The rST is then run throughSphinx,a static site generator that converts the rST into HTML for publication on theweb.
• Sphinx applies theFuro Theme for Sphinxto render the site.
• The guide is also accessible directly on GitLab using theGitLab pages feature.
• GitLab handles theCI/CD pipelinefor the project.
• Successful pipelines on themaster branch get published to thedocs.saltproject.io domain