Chore: Add more info on subprojects 58/69058/5
authorJessica Wagantall <jwagantall@linuxfoundation.org>
Mon, 1 Nov 2021 19:05:46 +0000 (12:05 -0700)
committerJessica Wagantall <jwagantall@linuxfoundation.org>
Wed, 17 Nov 2021 17:28:16 +0000 (09:28 -0800)
Add more details on how to set up subprojects

Issue: IT-23187
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Change-Id: I59c940486c1b00956724862bcbb1cf8e541710e0

docs/project-documentation.rst

index 491ea52..79e7bf2 100644 (file)
@@ -93,8 +93,8 @@ Bootstrap your project with documentation by following these steps.
 Add a project to ReadTheDocs
 ============================
 
-In this task we will add a project to ReadTheDocs. This is necessary to let
-ReadTheDocs know where to pull your docs to build from.
+In this task we will add and activate a project to ReadTheDocs.
+This is necessary to let ReadTheDocs know where to pull your docs to build from.
 
 .. warning::
 
@@ -104,8 +104,6 @@ ReadTheDocs know where to pull your docs to build from.
    creating the project for you then open a
    :ref:`helpdesk ticket <lfdocs-helpdesk>`.
 
-Activate new created projects in ReadTheDocs using the RTD GUI
-
 #. Login to ReadTheDocs (LFIT can use the lf-rtd account)
 #. Click "Import a Project" on the `dashboard
    <https://readthedocs.org/dashboard>`_
@@ -158,6 +156,14 @@ Activate new created projects in ReadTheDocs using the RTD GUI
 Appendix
 ========
 
+Activate new sub-project:
+-------------------------
+
+   a. Select the sub-project
+   b. Select Admin > Edit Versions
+   c. Locate the version to activate in the "Activate a version" list
+   d. Activate it by pressing the "Activate" button on the right hand side of the entry
+
 Intersphinx Linking
 -------------------