openstack/openstack-manuals
Code Issues Proposed changes

Add guidelines on the use of example URLs

Browse Source 
Change-Id: If83e0225e540dd1b6c88134737b50213485dd720
Partial-bug: 1611176
This commit is contained in:
Alexandra Settle 2017-01-17 17:18:00 +00:00 committed by Andreas Jaeger
parent ed1f815eba
commit 57da5de0ab
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/contributor-guide/source/writing-style.rst
View File

@ -17,6 +17,7 @@ throughout all technical publications.
writing-style/punctuation.rst
writing-style/headings.rst
writing-style/lists.rst
writing-style/urls.rst
writing-style/num_and_units_of_measure.rst
writing-style/openstack-components.rst
writing-style/release-names.rst

14
doc/contributor-guide/source/writing-style/urls.rst Normal file
View File

@ -0,0 +1,14 @@
====
URLs
====
Use the following example URL as a guideline for the use of example URLs.
.. note::
Example.org is reserved by IANA for example URLs.
Use the convention `project_name`, then `openstack`, followed by `example.org`.
For example:
``http://glance.openstack.example.org/``