starlingx/docs
Code Issues Proposed changes

Extend Docs Contributor guide

Browse Source 
Extended to cover changes made under:
https://review.opendev.org/c/starlingx/docs/+/833617

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I3977c586ad4e1eb8a74b28c6b0609a012f4cfc90
This commit is contained in:
Ron Stone 2022-03-14 08:23:17 -04:00
parent 0b9b0d50ba
commit e0c21f990c
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`.