Add plugin api docs

closes #2180 https://pulp.plan.io/issues/2180
pulp · Jun 8, 2017 · ff0f968 · ff0f968
1 parent 1b69d37
commit ff0f968
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 2 deletions.
diff --git a/docs/contributing/3.0-development/plugin-layout.rst b/docs/contributing/3.0-development/plugin-layout.rst
@@ -16,9 +16,9 @@ Plugin API
 ----------
 
 The Pulp :doc:`../plugin_api/index` is versioned separately from the Pulp Platform, and consists
-of everything importable withing the :mod:`pulp.plugin` namespace. When writing plugins, care should
+of everything importable withing the :mod:`pulpcore.plugin` namespace. When writing plugins, care should
 be taken to only import Pulp Platform components exposed in this namespace; importing from elsewhere
-within the Pulp Platform (e.g. importing directly from ``pulp.app``, ``pulp.exceptions``, etc.)
+within the Pulp Platform (e.g. importing directly from ``pulpcore.app``, ``pulpcore.exceptions``, etc.)
 is unsupported, and not protected by the Pulp Plugin API's semantic versioning guarantees.
 
 .. warning::
@@ -84,3 +84,13 @@ of a plugin app, and so on.
 
 This matching of module names is required for the Pulp Platform to be able to auto-discover
 plugin components, particularly for both models and viewsets.
+
+
+Packaging
+---------
+
+The Plugin API is available from PyPI as pulpcore-plugin. A plugin writer needs to specify the
+minimum version of pulpcore-plugin their plugin is dependent on. A plugin writer does not need to
+specify which version of pulpcore would work with their plugin since pulpcore-plugin will
+resolve the pulpcore dependency. Please see :doc:`release notes <../../release_notes/index>`
+for the supported versions of pulpcore.
diff --git a/docs/contributing/plugin_api/index.rst b/docs/contributing/plugin_api/index.rst
@@ -1,6 +1,12 @@
 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. For the latest version of the Plugin API see
+:doc:`release notes <../../release_notes/index>`.
+
+
 .. toctree::
     models
     serializers

diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst
@@ -1,2 +1,14 @@
 Release Notes
 =============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Pulp Core
+
+   pulpcore/3.0.x
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Plugin API
+
+   plugin_api/0.0.z
diff --git a/docs/release_notes/plugin_api/0.0.z.rst b/docs/release_notes/plugin_api/0.0.z.rst
@@ -0,0 +1,18 @@
+============================
+Plugin API 0.0 Release Notes
+============================
+
+The Plugin API is not yet declared as stable. Backwards incompatible changes might be made until
+stable version 1.0 is reached.
+
+The Plugin API currently supports version 3.y of Pulp Core.
+
+See :doc:`Plugin API <../../contributing/plugin_api/index>` and
+:doc:`Plugin Development <../../contributing/3.0-development/plugin-layout>`
+
+
+Plugin API 0.0.1
+================
+
+Features
+--------
diff --git a/docs/release_notes/pulpcore/3.0.x.rst b/docs/release_notes/pulpcore/3.0.x.rst
@@ -0,0 +1,2 @@
+Pulp 3.0 Release Notes
+======================