You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by GitBox <gi...@apache.org> on 2021/05/21 09:42:54 UTC

[GitHub] [cloudstack-documentation] rhtyd commented on a change in pull request #199: ui: added customization details

rhtyd commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r636784217



##########
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:
       @shwstppr maybe you don't need to show all the mapping but the general idea of what they are and how users can change them - i.e. remap them by using the config.json file.




-- 
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:
users@infra.apache.org