From 5ea4159531fb743fa56003251abe4c1f47fca521 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Wed, 14 Feb 2018 18:03:30 +0100 Subject: [PATCH] Update content on project docs setup per project docs migration Link to doc-contrib-guide for further instructions. Fix a Fedora command. Change-Id: Iaf0106146d49cd168c6fa4a6a734379fdba3ca93 --- doc/source/creators.rst | 22 ++++++++++++---------- doc/source/developers.rst | 6 +++--- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/source/creators.rst b/doc/source/creators.rst index 9677c55..eb07971 100644 --- a/doc/source/creators.rst +++ b/doc/source/creators.rst @@ -927,15 +927,18 @@ go ahead. If you are creating a brand new project, add some code and tests to provide some minimal functionality. -Provide Basic Developer Documentation -------------------------------------- +Provide Basic Project Documentation +----------------------------------- Update the ``README.rst`` file to include a paragraph describing the new project. Update the rest of the documentation under ``doc/source`` with -information about the public API, tips on adopting the tool, -instructions for running the tests, etc. +information on how to contribute to the project. Add project-specific +documentation covering different content areas based on the intended audience, +such as installation, configuration, and administration. Follow the layout +of project documentation as described in `Project guide setup +`_. Tagging a Release ----------------- @@ -1025,15 +1028,14 @@ Updating devstack _REPO=${_REPO:-${GIT_BASE}/openstack/.git} _BRANCH=${_BRANCH:-master} -Add Link to Your Developer Documentation -======================================== +Add Links to Your Project Documentation +======================================= If your project is not an official OpenStack project, skip this section. -Update the https://docs.openstack.org/openstack-projects.html -page with a link to your documentation by checking out the -``openstack/openstack-manuals`` repository and editing -``www/developer/openstack-projects.html``. +Update the https://docs.openstack.org/ site with links to your project +documentation by following the instructions at `Template generator details +`_. Enabling Translation Infrastructure =================================== diff --git a/doc/source/developers.rst b/doc/source/developers.rst index 8709303..7ee76d5 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -153,10 +153,10 @@ distribution, so install it as any other package:: apt-get install git-review -On Fedora 16 and later, git-review is included into the distribution, -so install it as any other package:: +On Fedora, git-review is included into the distribution, so install it as any +other package:: - yum install git-review + dnf install git-review On Red Hat Enterprise Linux, you must first enable the `EPEL `_ repository, then install it as