Merge "Add repository depreciation warning"

2019-07-18 15:24:50 +00:00 · 2019-07-18 15:24:50 +00:00 · d8a38f08c3
parent c427d9b607 b240a19c6c
commit d8a38f08c3
11 changed files with 94 additions and 2 deletions
--- a/doc/source/api-conventions.rst
+++ b/doc/source/api-conventions.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _api-conventions:

 API Conventions
@ -348,4 +354,6 @@ Success message example::
  }

 .. _Kubernetes standard for error representation: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#response-status-kind
-.. _HTTP status code: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+.. _HTTP status code: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/code-conventions.rst
+++ b/doc/source/code-conventions.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _code-conventions:

 Code and Project Conventions
@ -210,3 +216,5 @@ prevail.
 .. _Docker: https://www.docker.com/
 .. _helm-toolkit: https://opendev.org/openstack/openstack-helm-infra/src/branch/master/helm-toolkit
 .. _Openstack-Helm: https://wiki.openstack.org/wiki/Openstack-helm
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/conventions.rst
+++ b/doc/source/conventions.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _conventions:

 Airship Conventions
@ -44,3 +50,5 @@ Conventions and Standards
   service-logging-conventions

 .. _RFC 2119: https://www.ietf.org/rfc/rfc2119.txt
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/dev-getting-started.rst
+++ b/doc/source/dev-getting-started.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _dev-getting-started:

 Getting Started for Airship Developers
@ -160,3 +166,5 @@ of testing.
 .. _quay.io: https://quay.io/organization/airshipit
 .. _stestr: https://github.com/mtreinish/stestr
 .. _YAML: http://yaml.org/
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/documentation-conventions.rst
+++ b/doc/source/documentation-conventions.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _documentation-conventions:

 Documentation
@ -85,3 +91,5 @@ main/index page of their `Readthedocs`_ documentation:
 .. _Github: https://github.com
 .. _Sphinx: http://www.sphinx-doc.org/en/stable/index.html
 .. _Treasuremap: https://opendev.org/airship/treasuremap/
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. note::

  These documents will be reworked to reflect the changes associated with
@ -64,3 +70,5 @@ Conventions and Standards
 .. _Treasuremap: https://opendev.org/airship/treasuremap/
 .. _yaml: http://yaml.org/
 .. _specifications: /projects/specs
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/security/guide.rst
+++ b/doc/source/security/guide.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _security_guide:

 Airship Security Guide
@ -54,3 +60,6 @@ Airship Security Topics
  template
  haproxy
  ubuntu
+
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/security/haproxy.rst
+++ b/doc/source/security/haproxy.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _haproxy_security_guide:

 HAProxy Security Guide
@ -53,3 +59,6 @@ References
 ----------

 `HAProxy Configuration Guide <http://cbonte.github.io/haproxy-dconv/1.8/configuration.html>`_
+
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/security/template.rst
+++ b/doc/source/security/template.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _template_security_guide:

 Template for a Security Guide Topic
@ -68,3 +74,6 @@ References
 ----------

 `Transport Layer Security (TLS) <https://www.sans.org/reading-room/whitepapers/protocols/ssl-tls-beginners-guide-1029>`_
+
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/security/ubuntu.rst
+++ b/doc/source/security/ubuntu.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _ubuntu_security_guide:

 Canonical Ubuntu/MAAS Security Guide
@ -245,3 +251,6 @@ References
  * `Ubuntu 16.04 Server Guide <https://help.ubuntu.com/16.04/serverguide/security.html>`_
  * `Canonical MAAS 2.3 TLS <https://docs.maas.io/2.3/en/installconfig-network-ssl>`_
  * `Canonical MAAS 2.4 TLS <https://docs.maas.io/2.4/en/installconfig-network-ssl>`_
+
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/
--- a/doc/source/service-logging-conventions.rst
+++ b/doc/source/service-logging-conventions.rst
@ -14,6 +14,12 @@
      License for the specific language governing permissions and limitations
      under the License.

+.. warning::
+
+  This repository is being deprecated. Project documentation has moved to the
+  `Airship Docs`_ project, and Airship-in-a-Bottle environment will be merged
+  into the `Airship Treasuremap`_ project.
+
 .. _service-logging-conventions:

 Service Logging Conventions
@ -62,4 +68,6 @@ Components should prefer loggers that are at the module or class level,
 allowing for finer grained logging control than a global logger.


-.. _Python Logging: https://docs.python.org/3/library/logging.html
+.. _Python Logging: https://docs.python.org/3/library/logging.html
+.. _Airship Docs: https://airship-docs.readthedocs.org
+.. _Airship Treasuremap: https://opendev.org/airship/treasuremap/