https://github.com/saltstack/salt-user-guide

A guide on how to become awesome with the power of Salt
https://github.com/saltstack/salt-user-guide

Last synced: 8 months ago
JSON representation

A guide on how to become awesome with the power of Salt

• Host: GitHub
• URL: https://github.com/saltstack/salt-user-guide
• Owner: saltstack
• License: apache-2.0
• Created: 2024-10-22T20:52:39.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-01T16:54:21.000Z (9 months ago)
• Last Synced: 2025-05-01T17:49:12.247Z (9 months ago)
• Language: Python
• Homepage: https://docs.saltproject.io/salt/user-guide/en/latest/
• Size: 1.85 MB
• Stars: 2
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============

Salt User Guide

===============

.. image:: https://img.shields.io/badge/slack-SaltProject-blue.svg?logo=slack

   :target: https://via.vmw.com/salt-slack

.. image:: https://img.shields.io/twitch/status/saltprojectoss

   :target: https://www.twitch.tv/saltprojectoss

.. image:: https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social

   :target: https://www.reddit.com/r/saltstack/

.. image:: https://img.shields.io/twitter/follow/Salt_Project_OS?style=social&logo=twitter

   :target: https://twitter.com/intent/follow?screen_name=Salt_Project_OS

.. image:: https://img.shields.io/badge/stackoverflow-saltstack-orange.svg

   :target: https://stackoverflow.com/questions/tagged/salt-stack+or+salt-cloud+or+salt-creation+or+salt-contrib?sort=Newest

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 `__

About the 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.

Contributions from anyone inside the Salt project community are always welcome.

Please read the `Contributing to Salt documentation `__ for

more information.

Related links

=============

Check out the following links related to the Salt User 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 User 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.

* `Writing Salt documentation (rST guide) `__:

  For conventions and guidelines about formatting reStructured Text (rST) in

  Salt documentation.

Other Salt documentation

------------------------

The following documentation is part of the Salt Project documentation:

* `Salt Install Guide `__:

  This guide provides instructions for installing Salt on Salt supported operating

  systems. It also explains how to configure Salt, start Salt services, and verify

  your 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 needed

  to execute the Salt modules.

Overview of the toolchain

=========================

This repository uses the following tools:

* The Salt User 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 also accessible directly on GitLab using the

  `GitLab pages `__ feature.

* GitLab handles the

  `CI/CD pipeline `__

  for the project.

* Successful pipelines on the ``master`` branch get published to the ``docs.saltproject.io`` domain