Remove mentions of semver for plugin-api

fixes #7555 https://pulp.plan.io/issues/7555
pulp · Sep 23, 2020 · d31eb22 · d31eb22
1 parent b2f2669
commit d31eb22
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 16 deletions.
diff --git a/CHANGES/plugin_api/7555.doc b/CHANGES/plugin_api/7555.doc
@@ -0,0 +1 @@
+Removed mentions of semver in the plugin API docs, and replaced them with a link to the deprecation policy where appropriate.
diff --git a/docs/bugs-features.rst b/docs/bugs-features.rst
@@ -87,7 +87,7 @@ For **Backport Requests**
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Only bug fixes from newer versions can be requested to be backported. No features can be backported
-to older versions due to semantic versioning.
+to older versions.
 
 Please include:
 

diff --git a/docs/plugins/api-reference/index.rst b/docs/plugins/api-reference/index.rst
@@ -1,19 +1,13 @@
 Plugin API Reference
 --------------------
 
-The Plugin API is versioned separately from the Pulp Core and consists of everything importable
-within the :mod:`pulpcore.plugin` namespace. When writing plugins, care should be taken to only
-import Pulp Core components exposed in this namespace; importing from elsewhere within the Pulp
-Core (e.g. importing directly from ``pulpcore.app``, ``pulpcore.exceptions``, etc.) is unsupported,
-and not protected by the Pulp Plugin API's semantic versioning guarantees.
+The Plugin API is versioned in sync with ``pulpcore`` and consists of everything importable within the
+:mod:`pulpcore.plugin` namespace. It is governed by our `deprecation policy <_deprecation_policy>`_.
+When writing plugins, care should be taken to only import ``pulpcore`` components exposed in this
+namespace; importing from elsewhere within the ``pulpcore`` module (e.g. importing directly from
+``pulpcore.app``, ``pulpcore.exceptions``, etc.) is unsupported, and not protected by the
+aforementioned Pulp Plugin API deprecation policy.
 
-.. warning::
-
-    Exactly what is versioned in the Plugin API, and how, still has yet to be determined.
-    This documentation will be updated to clearly identify what guarantees come with the
-    semantic versioning of the Plugin API in the future. As our initial plugins are under
-    development prior to the release of Pulp 3.0, the Plugin API can be assumed to have
-    semantic major version 0, indicating that it is unstable and still being developed.
 
 .. toctree::
     models

diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst
@@ -18,9 +18,8 @@ Let us know when the plugin is ready and we will be happy to add it to the list
 Plugin API
 ==========
 
-The Pulp Plugin API is versioned separately from Pulp Core. It is governed by `semantic
-versioning <http://semver.org/>`_. Backwards incompatible changes may be made until the
-Plugin API reaches stability with v1.0.
+The Pulp Plugin API is published and versioned with ``pulpcore``. It is governed by our `deprecation
+policy <_deprecation_policy>`_.
 
 Plugin Writer's Guide
 ---------------------