If you're looking to install Salt, you've come to the right place!

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

The Salt Install Guide supplements and extends the core documentation for the Salt Project. This guide is intended to help Salt users install salt in their environment.

Contributions from anyone inside the Salt project community are always welcome. Please read the :ref:`contributing` for more information. The contributing guide can also be found in the source repository:

• CONTRIBUTING.rst

Check out the following links also related to the Salt Install Guide:

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

The following documentation is part of the Salt Project documentation:

• 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 needed to execute the Salt modules.
• Salt User Guide: The Salt User Guide supplements and extends the core documentation for the Salt Project. This guide is intended to help Salt users learn about Salt's core concepts and features. It was originally authored by Alan Cugler and reviewed as a cross-collaborative effort between many Salt experts.

This repository uses the following tools:

• The Salt Install Guide documentation is composed in reStructured text (rST), which is a version of Markdown that is generally used in Python-based projects.
• The rST is then run through Sphinx, a static site generator that converts the rST into HTML for publication on the web.
• Sphinx applies the Furo Theme for Sphinx to render the site.
• The guide is hosted directly on GitHub using the GitHub pages feature.
• GitHub Actions handle the CI/CD pipelines for the project.

New releases of the salt-install-guide are required in order to ensure the latest docs changes make it into docs.saltproject.io, which are collectively published via a private repository called builddocs. builddocs will do the following:

• Downloads the latest tarball builds from GitHub Releases of target docs repos

  • salt-install-guide
  • salt-user-guide

• Build reference docs from salt repo for supported release versions

To cut a new release of salt-install-guide:

• Create and push a new tag via git

• The new tag will trigger a GitHub Action workflow which will create a new release

  • The new release will include the latest built tarball!

• Upon completion of a new salt-install-guide release, a new workflow must be launched via builddocs if wanting these changes to be immediately live