diff --git a/doc/contributor-guide/source/writing-style.rst b/doc/contributor-guide/source/writing-style.rst index 76ea2263c9..acb6d4c797 100644 --- a/doc/contributor-guide/source/writing-style.rst +++ b/doc/contributor-guide/source/writing-style.rst @@ -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 diff --git a/doc/contributor-guide/source/writing-style/urls.rst b/doc/contributor-guide/source/writing-style/urls.rst new file mode 100644 index 0000000000..36e4842ce9 --- /dev/null +++ b/doc/contributor-guide/source/writing-style/urls.rst @@ -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/``