{"id":27949203,"url":"https://github.com/saltstack/salt-user-guide","last_synced_at":"2025-05-08T17:36:58.194Z","repository":{"id":290977252,"uuid":"876957166","full_name":"saltstack/salt-user-guide","owner":"saltstack","description":"A guide on how to become awesome with the power of Salt","archived":false,"fork":false,"pushed_at":"2025-05-01T16:54:21.000Z","size":1936,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-01T17:49:12.247Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.saltproject.io/salt/user-guide/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-22T20:52:39.000Z","updated_at":"2025-05-01T16:54:26.000Z","dependencies_parsed_at":"2025-05-01T17:59:18.393Z","dependency_job_id":null,"html_url":"https://github.com/saltstack/salt-user-guide","commit_stats":null,"previous_names":["saltstack/salt-user-guide"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-user-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-user-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-user-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-user-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack","download_url":"https://codeload.github.com/saltstack/salt-user-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252902666,"owners_count":21822273,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T15:20:19.999Z","updated_at":"2025-05-07T15:20:21.264Z","avatar_url":"https://github.com/saltstack.png","language":"Python","readme":"===============\nSalt User Guide\n===============\n\n.. image:: https://img.shields.io/badge/slack-SaltProject-blue.svg?logo=slack\n   :target: https://via.vmw.com/salt-slack\n\n.. image:: https://img.shields.io/twitch/status/saltprojectoss\n   :target: https://www.twitch.tv/saltprojectoss\n\n.. image:: https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social\n   :target: https://www.reddit.com/r/saltstack/\n\n.. image:: https://img.shields.io/twitter/follow/Salt_Project_OS?style=social\u0026logo=twitter\n   :target: https://twitter.com/intent/follow?screen_name=Salt_Project_OS\n\n.. image:: https://img.shields.io/badge/stackoverflow-saltstack-orange.svg\n   :target: https://stackoverflow.com/questions/tagged/salt-stack+or+salt-cloud+or+salt-creation+or+salt-contrib?sort=Newest\n\nIf you're looking to learn about Salt, you've come to the right place.\n\n- `View the Sphinx-built documentation here \u003chttps://docs.saltproject.io/salt/user-guide/en/latest/index.html\u003e`__\n- `View the source repo here \u003chttps://gitlab.com/saltstack/open/docs/salt-user-guide\u003e`__\n\nAbout the Salt User Guide\n=========================\n\nThe Salt User Guide supplements and extends the core documentation for the\n`Salt Project \u003chttps://github.com/saltstack/salt\u003e`__. This guide is intended to\nhelp Salt users learn about Salt's core concepts and features. It was originally\nauthored by Alan Cugler and reviewed as a cross-collaborative effort between\nmany Salt experts.\n\nContributions from anyone inside the Salt project community are always welcome.\nPlease read the `Contributing to Salt documentation \u003cCONTRIBUTING.md\u003e`__ for\nmore information.\n\n\nRelated links\n=============\nCheck out the following links related to the Salt User Guide:\n\n* `Salt Project \u003chttps://github.com/saltstack/salt\u003e`__: The repository for the\n  Salt Project.\n* `Salt Project Home Page \u003chttps://saltproject.io/\u003e`__: The web portal for\n  Salt community events and resources.\n* `Contributing Guide \u003chttps://saltstack.gitlab.io/open/docs/docs-hub/topics/contributing.html\u003e`__:\n  For information about contributing to the Salt User Guide and other Salt\n  documentation projects, including how to set up your environment and other\n  policies around submitting merge requests or issues.\n* `Salt Style Guide \u003chttps://saltstack.gitlab.io/open/docs/docs-hub/topics/style-guide.html\u003e`__:\n  For general guidance about using Salt Project terms and other style or\n  formatting conventions.\n* `Writing Salt documentation (rST guide) \u003chttps://saltstack.gitlab.io/open/docs/docs-hub/topics/rst-guide.html\u003e`__:\n  For conventions and guidelines about formatting reStructured Text (rST) in\n  Salt documentation.\n\n\n\nOther Salt documentation\n------------------------\nThe following documentation is part of the Salt Project documentation:\n\n* `Salt Install Guide \u003chttps://docs.saltproject.io/salt/install-guide/en/latest/\u003e`__:\n  This guide provides instructions for installing Salt on Salt supported operating\n  systems. It also explains how to configure Salt, start Salt services, and verify\n  your installation.\n* `Salt Project documentation \u003chttps://docs.saltproject.io/en/latest/contents.html\u003e`__:\n  Includes the full documentation for the Salt Project.\n* `Module documentation \u003chttps://docs.saltproject.io/en/latest/py-modindex.html\u003e`__:\n  The Salt modules and state modules explain the use cases and arguments needed\n  to execute the Salt modules.\n\n\nOverview of the toolchain\n=========================\nThis repository uses the following tools:\n\n* The Salt User Guide documentation is composed in\n  `reStructured text (rST) \u003chttps://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html\u003e`__,\n  which is a version of Markdown that is generally used in Python-based projects.\n* The rST is then run through `Sphinx \u003chttps://www.sphinx-doc.org/en/master/\u003e`__,\n  a static site generator that converts the rST into HTML for publication on the\n  web.\n* Sphinx applies the\n  `Furo Theme for Sphinx \u003chttps://github.com/pradyunsg/furo\u003e`__\n  to render the site.\n* The guide is also accessible directly on GitLab using the\n  `GitLab pages \u003chttps://docs.gitlab.com/ee/user/project/pages/\u003e`__ feature.\n* GitLab handles the\n  `CI/CD pipeline \u003chttps://gitlab.com/saltstack/open/docs/salt-user-guide/-/pipelines\u003e`__\n  for the project.\n* Successful pipelines on the ``master`` branch get published to the ``docs.saltproject.io`` domain\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-user-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack%2Fsalt-user-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-user-guide/lists"}