opendev/infra-manual
Code Issues Proposed changes

Update content on project docs setup per project docs migration

Browse Source 
Link to doc-contrib-guide for further instructions.
Fix a Fedora command.

Change-Id: Iaf0106146d49cd168c6fa4a6a734379fdba3ca93
This commit is contained in:
Petr Kovar 2018-02-14 18:03:30 +01:00
parent ba9e093a83
commit 5ea4159531
2 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/creators.rst
View File

@ -927,15 +927,18 @@ go ahead.
If you are creating a brand new project, add some code and tests If you are creating a brand new project, add some code and tests
to provide some minimal functionality. to provide some minimal functionality.
Provide Basic Developer Documentation Provide Basic Project Documentation
------------------------------------- -----------------------------------
Update the ``README.rst`` file to include a paragraph describing the Update the ``README.rst`` file to include a paragraph describing the
new project. new project.
Update the rest of the documentation under ``doc/source`` with Update the rest of the documentation under ``doc/source`` with
information about the public API, tips on adopting the tool, information on how to contribute to the project. Add project-specific
instructions for running the tests, etc. 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
<https://docs.openstack.org/doc-contrib-guide/project-guides.html>`_.
Tagging a Release Tagging a Release
----------------- -----------------
@ -1025,15 +1028,14 @@ Updating devstack
<PROJECTNAME>_REPO=${<PROJECTNAME>_REPO:-${GIT_BASE}/openstack/<projectname>.git} <PROJECTNAME>_REPO=${<PROJECTNAME>_REPO:-${GIT_BASE}/openstack/<projectname>.git}
<PROJECTNAME>_BRANCH=${<PROJECTNAME>_BRANCH:-master} <PROJECTNAME>_BRANCH=${<PROJECTNAME>_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. If your project is not an official OpenStack project, skip this section.
Update the https://docs.openstack.org/openstack-projects.html Update the https://docs.openstack.org/ site with links to your project
page with a link to your documentation by checking out the documentation by following the instructions at `Template generator details
``openstack/openstack-manuals`` repository and editing <https://docs.openstack.org/doc-contrib-guide/doc-tools/template-generator.html>`_.
``www/developer/openstack-projects.html``.
Enabling Translation Infrastructure Enabling Translation Infrastructure
=================================== ===================================

6
doc/source/developers.rst
View File

@ -153,10 +153,10 @@ distribution, so install it as any other package::
apt-get install git-review apt-get install git-review
On Fedora 16 and later, git-review is included into the distribution, On Fedora, git-review is included into the distribution, so install it as any
so install it as any other package:: other package::
yum install git-review dnf install git-review
On Red Hat Enterprise Linux, you must first enable the `EPEL On Red Hat Enterprise Linux, you must first enable the `EPEL
<https://fedoraproject.org/wiki/EPEL>`_ repository, then install it as <https://fedoraproject.org/wiki/EPEL>`_ repository, then install it as