mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Refresh readme; import readme via Sphinx
This commit is contained in:
ScriptAutomate
Megan Wilhite
parent
497d0df402
commit
2a83ef6402
3 changed files with 91 additions and 115 deletions
191
README.rst
191
README.rst
|
|
@ -1,113 +1,86 @@
|
|||
.. raw:: html
|
||||
.. image:: https://img.shields.io/github/license/saltstack/salt
|
||||
:alt: Salt Project License: Apache v2.0
|
||||
:target: https://github.com/saltstack/salt/blob/master/LICENSE
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/saltstack/salt/blob/master/LICENSE" alt="License Apache 2.0">
|
||||
<img src="https://img.shields.io/github/license/saltstack/salt" /></a>
|
||||
<a href="https://pypi.org/project/salt">
|
||||
<img src="https://img.shields.io/pypi/dm/salt?label=pypi%20downloads"
|
||||
alt="commits since last release"></a>
|
||||
<a href="https://coveralls.io/github/saltstack/salt">
|
||||
<img src="https://img.shields.io/coveralls/github/saltstack/salt"
|
||||
alt="coverage"></a>
|
||||
<a href="https://lgtm.com/projects/g/saltstack/salt/context:python">
|
||||
<img src="https://img.shields.io/lgtm/grade/python/github/saltstack/salt"
|
||||
alt="Code quality: python"/></a>
|
||||
</br>
|
||||
<a href="https://saltstackcommunity.herokuapp.com/">
|
||||
<img src="https://img.shields.io/badge/slack-@saltstackcommunity-blue.svg?logo=slack"
|
||||
alt="chat on Slack"></a>
|
||||
<a href="https://www.twitch.tv/saltstackinc">
|
||||
<img src="https://img.shields.io/twitch/status/saltstackinc"
|
||||
alt="Watch on Twitch"></a>
|
||||
<a href="https://www.reddit.com/r/saltstack/">
|
||||
<img src="https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social"
|
||||
alt="chat on reddit"></a>
|
||||
<a href="https://twitter.com/intent/follow?screen_name=saltstack">
|
||||
<img src="https://img.shields.io/twitter/follow/saltstack?style=social&logo=twitter"
|
||||
alt="follow on Twitter"></a>
|
||||
</p>
|
||||
.. image:: https://img.shields.io/pypi/dm/salt?label=pypi%20downloads
|
||||
:alt: PyPi Package Downloads
|
||||
:target: https://pypi.org/project/salt
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<p align="center">
|
||||
<a href="https://saltstack.com">
|
||||
<img src="doc/_static/salt-oss-logo.png" alt="Salt Logo" width="300">
|
||||
</a>
|
||||
<p align="center">
|
||||
<a href="https://repo.saltstack.com/">
|
||||
<img src="https://img.shields.io/github/v/release/saltstack/salt"
|
||||
alt="Latest release version"></a>
|
||||
</br>
|
||||
<b>Salt</b> is the world’s fastest, most intelligent and scalable automation engine.
|
||||
<br />
|
||||
<a href="https://docs.saltstack.com/en/latest/"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
<a href="https://www.saltstack.com/try-salt-open/">Demo Salt For Free Online</a>
|
||||
·
|
||||
<a href="https://github.com/saltstack/salt/issues/new?assignees=&labels=Bug&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
|
||||
·
|
||||
<a href="https://github.com/saltstack/salt/issues/new?assignees=&labels=Feature&template=feature_request.md&title=%5BFEATURE+REQUEST%5D">Request Feature</a>
|
||||
</p>
|
||||
</p>
|
||||
.. image:: https://img.shields.io/lgtm/grade/python/github/saltstack/salt
|
||||
:alt: PyPi Package Downloads
|
||||
:target: https://lgtm.com/projects/g/saltstack/salt/context:python
|
||||
|
||||
.. image:: https://img.shields.io/badge/slack-@saltstackcommunity-blue.svg?logo=slack
|
||||
:alt: Salt Project Slack Community
|
||||
:target: https://saltstackcommunity.herokuapp.com/
|
||||
|
||||
.. image:: https://img.shields.io/twitch/status/saltstackinc
|
||||
:alt: Salt Project Twitch Channel
|
||||
:target: https://www.twitch.tv/saltstackinc
|
||||
|
||||
.. image:: https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social
|
||||
:alt: Salt Project subreddit
|
||||
:target: https://www.reddit.com/r/saltstack/
|
||||
|
||||
.. image:: https://img.shields.io/twitter/follow/saltstack?style=social&logo=twitter
|
||||
:alt: Follow SaltStack on Twitter
|
||||
:target: https://twitter.com/intent/follow?screen_name=saltstack
|
||||
|
||||
.. figure:: https://gitlab.com/saltstack/open/salt-branding-guide/-/raw/master/logos/SaltProject_altlogo_teal.png?inline=true
|
||||
:scale: 80 %
|
||||
:width: 1000px
|
||||
:height: 356px
|
||||
:align: center
|
||||
:alt: Salt Project Logo
|
||||
|
||||
* `Latest Salt Documentation`_
|
||||
* `Open an issue`_ (bug report, feature request, etc.)
|
||||
|
||||
*Salt is the world’s fastest, most intelligent and scalable automation*
|
||||
*engine.*
|
||||
|
||||
About Salt
|
||||
==========
|
||||
|
||||
Built on python, Salt uses simple and human-readable YAML combined with
|
||||
event-driven automation to deploy and configure complex IT systems. In addition
|
||||
to powering SaltStack’s powerful enterprise product suite, Salt can be found
|
||||
under the hood of products from Juniper, Cisco, Cloudflare, Nutanix, SUSE, and
|
||||
Tieto, to name a few.
|
||||
to leveling-up `vRealize Automation SaltStack Config`_, Salt can be found under
|
||||
the hood of products from Juniper, Cisco, Cloudflare, Nutanix, SUSE, and Tieto,
|
||||
to name a few.
|
||||
|
||||
About SaltStack
|
||||
===============
|
||||
|
||||
SaltStack develops award-winning software used by IT and security operations
|
||||
teams to help modern business more efficiently secure and maintain all aspects
|
||||
of their digital infrastructure. But we’re not like other legacy systems
|
||||
management or security software tools. Our software is unique in providing
|
||||
intelligent, event-driven automation for efficient control of complex business
|
||||
systems at any scale.
|
||||
|
||||
We help enterprise IT organizations orchestrate and automate difficult IT tasks
|
||||
with speed and flexibility to ultimately deliver continuous security compliance,
|
||||
vulnerability remediation, and real IT security.
|
||||
|
||||
Whether you need help automating the work of ITOps, DevOps, NetOps, or SecOps
|
||||
functions, SaltStack software is the answer. In addition to open source
|
||||
software, such as Salt, we offer
|
||||
`SaltStack Enterprise <https://www.saltstack.com/products/saltstack-enterprise/>`_
|
||||
and
|
||||
`SaltStack SecOps <https://www.saltstack.com/products/secops/>`_ products to
|
||||
manage and secure your digital business operations.
|
||||
`SaltStack was acquired by VMware in 2020 <https://www.vmware.com/company/acquisitions/saltstack.html>`_.
|
||||
Salt Project remains an open source ecosystem that VMware supports and
|
||||
contributes to.
|
||||
|
||||
Download Salt
|
||||
=============
|
||||
|
||||
Salt is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu,
|
||||
Windows. Download Salt and get started now.
|
||||
Salt is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu, MacOS,
|
||||
Windows, and more. Download Salt and get started now.
|
||||
|
||||
* `<https://repo.saltstack.com/>`_
|
||||
* `Installation Instructions <https://docs.saltstack.com/en/latest/topics/installation/index.html>`_
|
||||
* `<https://repo.saltproject.io/>`_
|
||||
* `Installation Instructions <https://docs.saltproject.io/en/latest/topics/installation/index.html>`_
|
||||
|
||||
SaltStack Documentation
|
||||
=======================
|
||||
Salt Project Documentation
|
||||
==========================
|
||||
|
||||
Installation instructions, getting started guides, in-depth API
|
||||
documentation, and contributing to Salt.
|
||||
|
||||
* `Getting Started with Salt <https://docs.saltstack.com/en/getstarted/>`_
|
||||
* `Latest Salt Documentation <https://docs.saltstack.com/en/latest/>`_
|
||||
* `Salt’s Contributor Guide <https://docs.saltstack.com/en/latest/topics/development/contributing.html>`_
|
||||
* `Getting Started with Salt <https://docs.saltproject.io/en/getstarted/>`_
|
||||
* `Latest Salt Documentation`_
|
||||
* `Salt’s Contributor Guide <https://docs.saltproject.io/en/latest/topics/development/contributing.html>`_
|
||||
|
||||
Security Advisories
|
||||
===================
|
||||
|
||||
In 2020, SaltStack created a
|
||||
`**Security Announcements** <https://www.saltstack.com/security-announcements/>`_
|
||||
landing page. SaltStack recommends subscribing to the
|
||||
`SaltStack Security RSS feed <http://www.saltstack.com/feed/?post_type=security>`_
|
||||
Keep an eye on the Salt Project
|
||||
`Security Announcements <https://www.saltproject.io/security-announcements/>`_
|
||||
landing page. Salt Project recommends subscribing to the
|
||||
`Salt Project Security RSS feed <http://www.saltproject.io/feed/?post_type=security>`_
|
||||
to receive notification when new information is available regarding security
|
||||
announcements.
|
||||
|
||||
|
|
@ -120,55 +93,47 @@ Responsibly Reporting Security Vulnerabilities
|
|||
++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
When reporting security vulnerabilities for Salt or other SaltStack projects,
|
||||
refer to the
|
||||
`SECURITY.md <https://github.com/saltstack/salt/blob/master/SECURITY.md>`_ file
|
||||
found in this repository.
|
||||
refer to the `SECURITY.md`_ file found in this repository.
|
||||
|
||||
Engage SaltStack and The Community
|
||||
==================================
|
||||
Engage the Salt Project and The Community
|
||||
=========================================
|
||||
|
||||
Please be sure to review our
|
||||
`Code of Conduct <https://github.com/saltstack/salt/blob/master/CODE_OF_CONDUCT.md>`_.
|
||||
Also, check out some of our community resources including:
|
||||
|
||||
* `SaltStack Community Wiki <https://github.com/saltstack/community/wiki>`_
|
||||
* `SaltStack Community Slack <https://saltstackcommunity.herokuapp.com/>`_
|
||||
* `SaltStack: IRC on Freenode <https://webchat.freenode.net/#salt>`_
|
||||
* `SaltStack YouTube channel <https://www.youtube.com/user/SaltStack>`_
|
||||
* `SaltStackInc Twitch channel <https://www.twitch.tv/saltstackinc>`_
|
||||
* `Salt Project Community Wiki <https://github.com/saltstack/community/wiki>`_
|
||||
* `Salt Project Community Slack <https://saltstackcommunity.herokuapp.com/>`_
|
||||
* `Salt Project: IRC on Freenode <https://webchat.freenode.net/#salt>`_
|
||||
* `Salt Project YouTube channel <https://www.youtube.com/user/SaltStack>`_
|
||||
* `Salt Project Twitch channel <https://www.twitch.tv/saltstackinc>`_
|
||||
|
||||
There are lots of ways to get involved in our community. Every month, there are
|
||||
around a dozen opportunities to meet with other contributors and the Salt Core
|
||||
team and collaborate in real time. The best way to keep track is by subscribing
|
||||
to the
|
||||
`Salt Community Events Calendar <https://calendar.google.com/calendar/embed?src=saltstack.com_md73c3ufcs2eqbsmmnike4em80%40group.calendar.google.com&ctz=America%2FNew_York>`_.
|
||||
to the **Salt Project Community Events Calendar** on the main
|
||||
`<https://saltproject.io>`__ website.
|
||||
|
||||
If you have additional questions, email us at core@saltstack.com or reach out
|
||||
directly to the Community Manager, Cassandra Faris via Slack. We’d be glad to
|
||||
directly to the Community Manager, Janae Andrus via Slack. We’d be glad to
|
||||
have you join our community!
|
||||
|
||||
SaltStack Training
|
||||
++++++++++++++++++
|
||||
|
||||
Get access to proprietary
|
||||
`SaltStack education offerings <https://www.saltstack.com/products/saltstack-training/>`_
|
||||
through instructor-led training offered on-site, virtually or at SaltStack
|
||||
headquarters in Salt Lake City. SaltStack Enterprise training helps increase the
|
||||
value and effectiveness of SaltStack software for any customer and is a
|
||||
prerequisite for coveted **SaltStack Certified Administrator (SSCA)** and
|
||||
**SaltStack Certified Engineer (SSCE)** certifications.
|
||||
|
||||
SaltStack training is also available through several
|
||||
`SaltStack professional services <https://www.saltstack.com/products/saltstack-services/>`_
|
||||
offerings.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
SaltStack is licensed by the SaltStack Team under the Apache 2.0 license. Please
|
||||
Salt is licensed under the Apache 2.0 license. Please
|
||||
see the
|
||||
`LICENSE file <https://github.com/saltstack/salt/blob/master/LICENSE>`_ for the
|
||||
full text of the Apache license, followed by a full summary of the licensing
|
||||
used by external modules.
|
||||
|
||||
A complete list of attributions and dependencies can be found here:
|
||||
`salt/DEPENDENCIES.md <https://github.com/saltstack/salt/blob/master/DEPENDENCIES.md>`_
|
||||
`salt/DEPENDENCIES.md <https://github.com/saltstack/salt/blob/master/DEPENDENCIES.md>`_
|
||||
|
||||
|
||||
.. _vRealize Automation SaltStack Config: https://www.vmware.com/products/vrealize-automation/saltstack-config.html
|
||||
.. _Latest Salt Documentation: https://docs.saltproject.io/en/latest/
|
||||
.. _Open an issue: https://github.com/saltstack/salt/issues/new/choose
|
||||
.. _SECURITY.md: https://github.com/saltstack/salt/blob/master/SECURITY.md
|
||||
.. _Calendar html: https://outlook.office365.com/owa/calendar/105f69bacd4541baa849529aed37eb2d@vmware.com/434ec2155b2b4cce90144c87f0dd03d56626754050155294962/calendar.html
|
||||
.. _Calendar ics: https://outlook.office365.com/owa/calendar/105f69bacd4541baa849529aed37eb2d@vmware.com/434ec2155b2b4cce90144c87f0dd03d56626754050155294962/calendar.ics
|
||||
|
|
|
|||
8
doc/_themes/saltstack2/layout.html
vendored
8
doc/_themes/saltstack2/layout.html
vendored
|
|
@ -33,7 +33,13 @@
|
|||
|
||||
{%- for rellink in rellinks|reverse %}
|
||||
<li>
|
||||
{%- if rellink[3] == "Table of Contents" and pathto(rellink[0]) != '#' %}
|
||||
<a href="{{ pathto(rellink[0]) }}#table-of-contents" title="{{ rellink[1]|striptags|e }}">{{ rellink[3] }}</a>
|
||||
{%- elif rellink[3] == "Table of Contents" and pathto(rellink[0]) == '#' %}
|
||||
<a href="{{ pathto(rellink[0]) }}table-of-contents" title="{{ rellink[1]|striptags|e }}">{{ rellink[3] }}</a>
|
||||
{%- else %}
|
||||
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}">{{ rellink[3] }}</a>
|
||||
{% endif %}
|
||||
{#
|
||||
{%- if not loop.last %}{{ reldelim2 }}{% endif %}
|
||||
#}
|
||||
|
|
@ -160,7 +166,7 @@
|
|||
<li><a href="/en/latest/">Overview</a></li>
|
||||
<li><a href="/en/getstarted/">Tutorials</a></li>
|
||||
<li><a href="/en/latest/contents.html">Documentation</a></li>
|
||||
<li><a href="https://repo.saltstack.com">Downloads</a></li>
|
||||
<li><a href="https://repo.saltproject.io">Downloads</a></li>
|
||||
<li><a href="/en/latest/topics/development/">Develop</a></li>
|
||||
<!--<li><a href="/en/2016.3/faq/">FAQ</a></li>
|
||||
<li><a href="/en/2016.3/samples/">Code Samples</a></li>-->
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
==========================
|
||||
Salt Project Documentation
|
||||
==========================
|
||||
|
||||
.. include:: ../README.rst
|
||||
|
||||
.. _table-of-contents:
|
||||
|
||||
======================
|
||||
Salt Table of Contents
|
||||
======================
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue