mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 17:33:54 +00:00
b173268d9e
GitHub uses a library called Licensee to identify a project's license type. It shows this information in the status bar and via the API if it can unambiguously identify the license. This commit modifies a few of SaltStack's docs so that Licensee is able to recognize the repository's license type. LICENSE has been updated to contain the full text of the Apache license. COPYING has been removed; the info regarding external module licensing is now stored at the bottom of LICENSE. This commit also adds a "License" section to the README to clarify the licensing for SaltStack as well as for external modules. The update to LICENSE and the consolidation of COPYING with LICENSE allow Licensee to successfully identify the license type of SaltStack as Apache. Signed-off-by: Andrea Kao <eirinikos@gmail.com>
124 lines
5.0 KiB
ReStructuredText
124 lines
5.0 KiB
ReStructuredText
==================
|
||
What is SaltStack?
|
||
==================
|
||
|
||
SaltStack makes software for complex systems management at scale.
|
||
SaltStack is the company that created and maintains the Salt Open
|
||
project and develops and sells SaltStack Enterprise software, services
|
||
and support. Easy enough to get running in minutes, scalable enough to
|
||
manage tens of thousands of servers, and fast enough to communicate with
|
||
them in *seconds*.
|
||
|
||
Salt is a new approach to infrastructure management built on a dynamic
|
||
communication bus. Salt can be used for data-driven orchestration,
|
||
remote execution for any infrastructure, configuration management for
|
||
any app stack, and much more.
|
||
|
||
Download Salt Open
|
||
==================
|
||
|
||
Salt Open is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu,
|
||
Windows. Download Salt Open and get started now.
|
||
|
||
`<https://repo.saltstack.com/>`_
|
||
|
||
`Installation Instructions <https://docs.saltstack.com/en/latest/topics/installation/index.html>`_
|
||
|
||
SaltStack Documentation
|
||
=======================
|
||
|
||
Installation instructions, getting started guides, and in-depth API
|
||
documentation.
|
||
|
||
`<https://docs.saltstack.com/en/getstarted/>`_
|
||
|
||
`<https://docs.saltstack.com/en/latest/>`_
|
||
|
||
Get SaltStack Support and Help
|
||
==============================
|
||
|
||
**IRC Chat** - Join the vibrant, helpful and positive SaltStack chat room in
|
||
Freenode at #salt. There is no need to introduce yourself, or ask permission to
|
||
join in, just help and be helped! Make sure to wait for an answer, sometimes it
|
||
may take a few moments for someone to reply.
|
||
|
||
`<http://webchat.freenode.net/?channels=salt&uio=Mj10cnVlJjk9dHJ1ZSYxMD10cnVl83>`_
|
||
|
||
**SaltStack Slack** - Alongside IRC is our SaltStack Community Slack for the
|
||
SaltStack Working groups. Use the following link to request an invitation.
|
||
|
||
`<https://saltstackcommunity.herokuapp.com/>`_
|
||
|
||
**Mailing List** - The SaltStack community users mailing list is hosted by
|
||
Google groups. Anyone can post to ask questions about SaltStack products and
|
||
anyone can help answer. Join the conversation!
|
||
|
||
`<https://groups.google.com/forum/#!forum/salt-users>`_
|
||
|
||
You may subscribe to the list without a Google account by emailing
|
||
salt-users+subscribe@googlegroups.com and you may post to the list by emailing
|
||
salt-users@googlegroups.com
|
||
|
||
**Reporting Issues** - To report an issue with Salt, please follow the
|
||
guidelines for filing bug reports:
|
||
`<https://docs.saltstack.com/en/develop/topics/development/reporting_bugs.html>`_
|
||
|
||
**SaltStack Support** - If you need dedicated, prioritized support, please
|
||
consider a SaltStack Support package that fits your needs:
|
||
`<http://www.saltstack.com/support>`_
|
||
|
||
Engage SaltStack
|
||
================
|
||
|
||
`SaltConf`_, **User Groups and Meetups** - SaltStack has a vibrant and `global
|
||
community`_ of customers, users, developers and enthusiasts. Connect with other
|
||
Salted folks in your area of the world, or join `SaltConf`_, the SaltStack
|
||
annual user conference held in Salt Lake City. Please visit the `SaltConf`_ site
|
||
for details of our next conference. Also, please let us know if you would like
|
||
to start a user group or if we should add your existing SaltStack user group to
|
||
this list by emailing: info@saltstack.com
|
||
|
||
**SaltStack Training** - Get access to proprietary `SaltStack education
|
||
offerings`_ 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 Engineer (SSCE)`_ status.
|
||
SaltStack training is also available through several `SaltStack professional
|
||
services`_ offerings.
|
||
|
||
**Follow SaltStack on -**
|
||
|
||
* YouTube - `<http://www.youtube.com/saltstack>`_
|
||
* Twitter - `<http://www.twitter.com/saltstack>`_
|
||
* Facebook - `<https://www.facebook.com/SaltStack/>`_
|
||
* LinkedIn - `<https://www.linkedin.com/company/salt-stack-inc>`_
|
||
* LinkedIn Group - `<https://www.linkedin.com/groups/4877160>`_
|
||
* Google+ - `<https://plus.google.com/b/112856352920437801867/+SaltStackInc/posts>`_
|
||
|
||
.. _global community: http://www.meetup.com/pro/saltstack/
|
||
.. _SaltConf: http://saltconf.com/
|
||
.. _SaltStack education offerings: http://saltstack.com/training/
|
||
.. _SaltStack Certified Engineer (SSCE): http://saltstack.com/certification/
|
||
.. _SaltStack professional services: http://saltstack.com/services/
|
||
|
||
Developing Salt
|
||
===============
|
||
|
||
The Salt development team is welcoming, positive, and dedicated to
|
||
helping people get new code and fixes into SaltStack projects. Log into
|
||
GitHub and get started with one of the largest developer communities in
|
||
the world. The following links should get you started:
|
||
|
||
`<https://github.com/saltstack>`_
|
||
|
||
`<https://docs.saltstack.com/en/latest/topics/development/index.html>`_
|
||
|
||
`<https://docs.saltstack.com/en/develop/topics/development/pull_requests.html>`_
|
||
|
||
License
|
||
=======
|
||
|
||
SaltStack is licensed by the SaltStack Team under the Apache 2.0 license. Please see the
|
||
LICENSE file for the full text of the Apache license, followed by a full summary
|
||
of the licensing used by external modules.
|