Doc how to find MR projects from POM or taglist

Document how to find the Managed Projects from the taglist.log file in
an ODL Managed Distribution archive or from the POM that defines how to
build the Managed Distribution.

Jira: DOCS-115
Change-Id: Ie52c8a457436f4902fc45515749893fbcc0f3a53
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>

diff --git a/docs/release-process/identifying-managed-projects.rst b/docs/release-process/identifying-managed-projects.rst
new file mode 100644 (file)
index 0000000..292a7f6
--- /dev/null
+++ b/docs/release-process/identifying-managed-projects.rst
@@ -0,0 +1,49 @@
+*******************************************************
+Identifying Managed Projects in an OpenDaylight Version
+*******************************************************
+
+What are Managed Projects?
+==========================
+
+Managed Projects are simply projects that take part in the :ref:`Managed
+Release Process <managed-release>`. Managed Projects are either core components
+of OpenDaylight or have demonstrated their maturity and ability to successfully
+take part in the Managed Release.
+
+For more information, see the full description of :ref:`Managed Projects
+<managed-projects>`.
+
+What is a Managed Distribution?
+===============================
+
+Managed Projects are aggregated together by a POM file that defines a Managed
+Distribution. The Managed Distribution is the focus of OpenDaylight
+development. It's continuously built, tested, packaged and released into
+Continuous Delivery pipelines. As prescribed by the Managed Release Process,
+Managed Distributions are eventually blessed as formal OpenDaylight releases.
+
+NB: OpenDaylight's Fluorine release actually included Managed and Self-Managed
+Projects, but the community is working towards the formal release being exactly
+the Managed Distribution, with an option for Self-Managed Projects to release
+independently on top of the Managed Distribution later.
+
+Finding the Managed Projects given a Managed Distribution
+=========================================================
+
+Given a Managed Distribution (tar.gz, .zip, RPM, Deb), the Managed Projects
+that constitute it can be found in the `taglist.log` file in the root of the
+archive.
+
+`taglist.log` files are of the format:
+
+.. code::
+
+        <Managed Project> <Git SHA of built commit> <Codename of release>
+
+Finding the Managed Projects Given a Branch
+===========================================
+
+To find the current set of Managed Projects in a given OpenDaylight branch,
+examine the `integration/distribution/features/repos/index/pom.xml`_ file that defines the Managed Distribution.
+
+.. _integration/distribution/features/repos/index/pom.xml: https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/repos/index/pom.xml

diff --git a/docs/release-process/index.rst b/docs/release-process/index.rst
index aeab996e9a88cd001aacf40dc557d4f539dd3f03..9ec5c6922b31ca5dfaa5d8d035f0bb5cac0529b9 100644 (file)
--- a/docs/release-process/index.rst
+++ b/docs/release-process/index.rst
@@ -38,6 +38,11 @@ Processes
 Supporting Documentation
 ************************
 
+.. toctree::
+   :maxdepth: 1
+
+   identifying-managed-projects
+
 The release management team maintains several documents in Google Drive to
 track releases. These documents can be found at this link:
 

diff --git a/docs/release-process/managed-release.rst b/docs/release-process/managed-release.rst
index 18c736a4e1b47438a43a06861c78e1baba249305..f5dbe0f2952020190e30ed7bf072087115e5a420 100644 (file)
--- a/docs/release-process/managed-release.rst
+++ b/docs/release-process/managed-release.rst
@@ -1,3 +1,5 @@
+.. _managed-release:
+
 ***************
 Managed Release
 ***************
@@ -49,6 +51,8 @@ stable, more responsive projects. The release team will also have greater
 latitude to step in and help projects that are required for dependency reasons
 but may not have a large set of active contributors.
 
+.. _managed-projects:
+
 Managed Projects
 ================