{"id":17943892,"url":"https://github.com/saltstack/salt-install-guide","last_synced_at":"2026-02-22T05:03:40.628Z","repository":{"id":259993763,"uuid":"876954320","full_name":"saltstack/salt-install-guide","owner":"saltstack","description":"A guide on installing Salt in your environment","archived":false,"fork":false,"pushed_at":"2026-01-10T00:32:53.000Z","size":841,"stargazers_count":6,"open_issues_count":4,"forks_count":12,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-01-27T19:25:36.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.saltproject.io/salt/install-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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-22T20:44:09.000Z","updated_at":"2026-01-10T00:30:46.000Z","dependencies_parsed_at":"2024-10-29T01:21:34.421Z","dependency_job_id":"ec87f185-c85f-4ed4-a913-4810f296f63a","html_url":"https://github.com/saltstack/salt-install-guide","commit_stats":null,"previous_names":["saltstack/salt-install-guide"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/saltstack/salt-install-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-install-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-install-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-install-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-install-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack","download_url":"https://codeload.github.com/saltstack/salt-install-guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-install-guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29705524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T03:17:42.375Z","status":"ssl_error","status_checked_at":"2026-02-22T03:17:31.622Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2024-10-29T05:03:32.808Z","updated_at":"2026-02-22T05:03:40.562Z","avatar_url":"https://github.com/saltstack.png","language":"Python","readme":"==================\nSalt install guide\n==================\n\n.. image:: https://img.shields.io/badge/slack-Salt%20Project-blue.svg?logo=discord\n   :alt: Salt Project Discord Community\n   :target: https://discord.gg/YVQamSwV3g\n\n.. image:: https://img.shields.io/pypi/dm/salt?label=pypi%20downloads\n   :alt: PyPi Package Downloads\n   :target: https://pypi.org/project/salt\n\n.. image:: https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social\n   :alt: Salt Project subreddit\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   :alt: Follow SaltStack on Twitter\n   :target: https://twitter.com/intent/follow?screen_name=Salt_Project_OS\n\n.. image:: https://img.shields.io/badge/stackoverflow-Salt%20Project-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 install Salt, you've come to the right place!\n\n- `View the Sphinx-built documentation here \u003chttps://docs.saltproject.io/salt/install-guide/en/latest/\u003e`__\n- `View the source repo here \u003chttps://github.com/saltstack/salt-install-guide\u003e`__\n\nAbout the Salt install guide\n============================\n\nThe Salt Install 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 install ``salt`` in their environment.\n\nContributions from anyone inside the Salt project community are always welcome.\nPlease read the :ref:`contributing` for more information. The contributing\nguide can also be found in the source repository:\n\n* `CONTRIBUTING.rst \u003chttps://github.com/saltstack/salt-install-guide/-/blob/master/CONTRIBUTING.rst\u003e`__\n\n\nRelated links\n=============\nCheck out the following links also related to the Salt Install 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/salt-install-guide/topics/contributing.html\u003e`_ -\n  For information about contributing to the Salt Install 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* `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 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* `Salt User Guide \u003chttps://docs.saltproject.io/salt/user-guide/en/latest/\u003e`__:\n  The Salt User Guide supplements and extends the core documentation for the\n  Salt Project. This guide is intended to help Salt users learn about Salt's\n  core concepts and features. It was originally authored by Alan Cugler and\n  reviewed as a cross-collaborative effort between many Salt experts.\n\n\nOverview of the toolchain\n=========================\nThis repository uses the following tools:\n\n* The Salt Install 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://pradyunsg.me/furo/\u003e`__ to render the site.\n* The guide is hosted directly on GitHub using the\n  `GitHub pages \u003chttps://pages.github.com/\u003e`__ feature.\n* GitHub Actions handle the\n  `CI/CD pipelines \u003chttps://github.com/saltstack/salt-install-guide/actions\u003e`__\n  for the project.\n\nRelease Process\n===============\n\nNew releases of the ``salt-install-guide`` are required in order to ensure the latest docs changes\nmake it into ``docs.saltproject.io``, which are collectively published via a private repository\ncalled ``builddocs``. ``builddocs`` will do the following:\n\n* Downloads the latest tarball builds from GitHub Releases of target docs repos\n    * ``salt-install-guide``\n    * ``salt-user-guide``\n* Build reference docs from ``salt`` repo for supported release versions\n\nTo cut a new release of ``salt-install-guide``:\n\n* Create and push a new tag via git\n* The new tag will trigger a GitHub Action workflow which will create a new release\n    * The new release will include the latest built tarball!\n* Upon completion of a new ``salt-install-guide`` release, a new workflow must be launched\n  via ``builddocs`` if wanting these changes to be immediately live\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-install-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack%2Fsalt-install-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-install-guide/lists"}