starlingx/docs
Code Issues Proposed changes

Merge "Extend Docs Contributor guide"

Browse Source
This commit is contained in:
Zuul 2022-03-16 11:47:34 +00:00 committed by Gerrit Code Review
commit 80d39d2035
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/contributor/doc_contribute_guide.rst
View File

@ -282,7 +282,9 @@ listing the directory will show a file similar to the following:
The following changes were made.
* All alphabetical characters were converted to lower case.
* All spaces and special characters, such as the ``!`` were replaced by
* *Not shown* The characters ``+``, ``-``, ``@``, and ``&`` are replaced with
``plus``, ``minus``, ``at``, and ``and`` respectively.
* All spaces and other special characters, such as the ``!`` were replaced by
dashes.
* A final dash and 12 digit random string were appended to the file name.
* The extension :file:`.rst` was added for all options except :kbd:`f`, in
@ -290,7 +292,6 @@ The following changes were made.
* If you chose to create an ``index`` file by selecting :kbd:`i` when prompted,
:file:`index-` was prepended to the file name.
Examining the file reveals that the label matches the file name, while the
title is preserved as typed. No label was added if you selected :kbd:`f`.