shwstppr commented on a change in pull request #199:
URL:
https://github.com/apache/cloudstack-documentation/pull/199#discussion_r636868503
##########
File path: source/adminguide/ui.rst
##########
@@ -273,8 +285,177 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
-Advanced Customisation
-~~~~~~~~~~~~~~~~~~~~~~
+Contextual help documentation URLs can be customized with the help of
`docBase` and `docHelpMappings` properties.
+To override a particular documentation URL, a mapping can be added for the URL
path in the config. A documentation URL is formed by combining the `docBase`
URL base and a path set in the source code. Adding a mapping for any particular
path in the configuration will result in generating documetation URL with
overridden path.
+By default, `docHelpMappings` lists all existing documentation URL suffixes,
mapped to themselves, in the configuration file that are used in the code.
+
+.. parsed-literal::
+
+ {
+ ...
+ "docHelpMappings": {
Review comment:
@rhtyd @sureshanaparti can you please suggest what exactly should be
done? Should I shorten the list here and move the complete list to a separate
file with a link here? The remapping bit is already mentioned later in the doc.
The complete list is only needed to give an idea to operators about what all
docHelpSuffix(es) are used by the API, to make it easier to remap.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
