Merge branch '18631-shell-login-sync'
[arvados-formula.git] / docs / README.rst
index 0fb3edae3c5a753f9e212e2a8b82a886e8620929..b756aaa333dd5bf1a492def5cd6c6ba81c981def 100644 (file)
@@ -1,19 +1,13 @@
 .. _readme:
 
+..
+   # Copyright (C) The Arvados Authors. All rights reserved.
+   #
+   # SPDX-License-Identifier: Apache-2.0
+
 arvados-formula
 ================
 
-|img_travis| |img_sr|
-
-.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/arvados-formula.svg?branch=master
-   :alt: Travis CI Build Status
-   :scale: 100%
-   :target: https://travis-ci.com/saltstack-formulas/arvados-formula
-.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
-   :alt: Semantic Release
-   :scale: 100%
-   :target: https://github.com/semantic-release/semantic-release
-
 A SaltStack formula to install and configure an `Arvados cluster <https://arvados.org>`_.
 
 .. contents:: **Table of Contents**
@@ -24,14 +18,6 @@ General notes
 See the full `SaltStack Formulas installation and usage instructions
 <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
 
-If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
-<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.
-
-If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
-which contains the currently released version. This formula is versioned according to `Semantic Versioning <http://semver.org/>`_.
-
-See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
-
 If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.
 
 Contributing to this repo
@@ -57,7 +43,7 @@ provided you configure the pillars the way you need them.
 
 Arvados currently has three dispatchers:
 
-* **crunch-dispatch-local** (for single node installations),
+* **crunch-dispatch-local** (for single node installations and testing purposes, not suitable for production),
 * **arvados-dispatch-cloud** (for dynamic compute on AWS or Azure) and
 * **crunch-dispatch-slurm** (for SLURM integration).