From e0c21f990c6a390b033740aa4e099c0243c685ba Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Mon, 14 Mar 2022 08:23:17 -0400 Subject: [PATCH] Extend Docs Contributor guide Extended to cover changes made under: https://review.opendev.org/c/starlingx/docs/+/833617 Signed-off-by: Ron Stone Change-Id: I3977c586ad4e1eb8a74b28c6b0609a012f4cfc90 --- doc/source/contributor/doc_contribute_guide.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index ef81d2375..07d1091c3 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -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`.