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/03/16 08:12:44 UTC
[GitHub] [cloudstack-documentation] shwstppr opened a new pull request #199: ui: added customization details
shwstppr opened a new pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199
Added details about UI customization with respect to new UI.
Documentation help override changes are related to https://github.com/apache/cloudstack/pull/4745
----------------------------------------------------------------
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
[GitHub] [cloudstack-documentation] rhtyd merged pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd merged pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845677849
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-800051162
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. [S]
----------------------------------------------------------------
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814797088
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] sureshanaparti commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
sureshanaparti commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r637849029
##########
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 If it is feasible to maintain these '_docHelpMappings_' in a separate json file, then you can go with it and let others know how these mappings can be updated for any new feature/improvement (may be, mention it in the README file). Otherwise, keep these mappings as it is and update the documentation about the mappings.
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-811716920
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 36)
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-800050823
@blueorangutan docbuild
----------------------------------------------------------------
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814846656
--
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
[GitHub] [cloudstack-documentation] shwstppr removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821006332
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845682630
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-811716049
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-839675494
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814790254
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 37)
--
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
[GitHub] [cloudstack-documentation] sureshanaparti commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
sureshanaparti commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r636709692
##########
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 is it possible to maintain this mappings in separate file, and access from it?
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r636750724
##########
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:
@sureshanaparti not sure if I completely understand you but in the actual config file for the newly created packages all mappings will be listed https://github.com/apache/cloudstack/pull/5014
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-839675494
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 58)
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-831765920
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-839675022
@rhtyd a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r608518579
##########
File path: source/adminguide/ui.rst
##########
@@ -273,6 +280,47 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
+Contextual help documentation URLs can be customized with the help of `docBase` and `docHelpMappings` properties.
+A list of documentation help suffixes in code can be obtained using following command:
Review comment:
@rhtyd done
##########
File path: source/adminguide/ui.rst
##########
@@ -273,6 +280,47 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
+Contextual help documentation URLs can be customized with the help of `docBase` and `docHelpMappings` properties.
+A list of documentation help suffixes in code can be obtained using following command:
+
+.. parsed-literal::
+
+ grep -rnw cloudstack/ui/src/config/section -e 'docHelp:'
+
+Below example shows configuration changes for custom documentation help URLs:
+
+.. parsed-literal::
+
+ {
+ ...
+ "docBase": http://mycustomwebsite.com,
+ ...
+ "docHelpMappings": {
+ "adminguide/virtual_machines.html": "custom_vm_page.html",
+ "adminguide/templates.html": "custom_templates_page.html"
+ },
+ ...
+ }
+
+UI also provides option to show custom plugins by displaying a custom HTML page or service in an iframe. Such plugins can be listed in the config file using `plugins` property.
+Example for adding a custom plugin:
+
+.. parsed-literal::
+
+ {
+ ...
+ plugins: [
+ {
+ "name": "ExamplePlugin",
+ "icon": "appstore",
+ "path": "example.html"
Review comment:
@rhtyd done
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-811716334
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-838038966
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 56)
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-831765920
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 54)
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845682244
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845678654
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 70)
--
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
[GitHub] [cloudstack-documentation] shwstppr removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-800050823
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814797719
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 38)
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-839674546
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814789763
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814797088
--
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
[GitHub] [cloudstack-documentation] shwstppr removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814789305
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821007631
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 41)
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845825533
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814789305
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821043398
--
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
[GitHub] [cloudstack-documentation] shwstppr removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-838037157
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
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:
users@infra.apache.org
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814796647
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-831765438
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r637843143
##########
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:
Rewrite it simply as:
```
"docHelpMappings": {
"map 1": "map1",
... snipped ...
"map n": "map n"
}
```
The intent is to tell users that the mappings will be in the config file that they need to re-map, we don't need to put the mapping list here - otherwise it will create a maintenance issue for docs (everytime the list changes, something needs to update it).
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-800051703
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 34)
----------------------------------------------------------------
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821006784
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814845438
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821007631
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845678654
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845678205
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845826452
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 73)
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-846958590
Nevermind my last comment - let's merge this - it's better for users to see the whole list.
--
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
[GitHub] [cloudstack-documentation] blueorangutan removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-800051703
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814846656
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 39)
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-821006332
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845683107
Doc build preview: http://qa.cloudstack.cloud/docs/WIP-PROOFING/pr/199. (SL-JID 71)
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-814845984
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845825826
@rhtyd a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-831764812
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-838037768
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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
[GitHub] [cloudstack-documentation] shwstppr removed a comment on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr removed a comment on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-845677849
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] shwstppr commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
shwstppr commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-838037157
@blueorangutan docbuild
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r605442258
##########
File path: source/adminguide/ui.rst
##########
@@ -273,6 +280,47 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
+Contextual help documentation URLs can be customized with the help of `docBase` and `docHelpMappings` properties.
+A list of documentation help suffixes in code can be obtained using following command:
Review comment:
Or can we suggest the end user/admin to use the UI (forms/views/actions etc) where they want the link to be changed to simply copy that link, remove the base URL from the link and put the mapping below?
--
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
[GitHub] [cloudstack-documentation] rhtyd commented on a change in pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
rhtyd commented on a change in pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#discussion_r605442692
##########
File path: source/adminguide/ui.rst
##########
@@ -273,6 +280,47 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
+Contextual help documentation URLs can be customized with the help of `docBase` and `docHelpMappings` properties.
+A list of documentation help suffixes in code can be obtained using following command:
+
+.. parsed-literal::
+
+ grep -rnw cloudstack/ui/src/config/section -e 'docHelp:'
+
+Below example shows configuration changes for custom documentation help URLs:
+
+.. parsed-literal::
+
+ {
+ ...
+ "docBase": http://mycustomwebsite.com,
+ ...
+ "docHelpMappings": {
+ "adminguide/virtual_machines.html": "custom_vm_page.html",
+ "adminguide/templates.html": "custom_templates_page.html"
+ },
+ ...
+ }
+
+UI also provides option to show custom plugins by displaying a custom HTML page or service in an iframe. Such plugins can be listed in the config file using `plugins` property.
+Example for adding a custom plugin:
+
+.. parsed-literal::
+
+ {
+ ...
+ plugins: [
+ {
+ "name": "ExamplePlugin",
+ "icon": "appstore",
+ "path": "example.html"
Review comment:
@shwstppr can you add another example, where the path is an external URL; for example:
```
"plugins": [{
"name": "External Link Example",
"icon": "hdd",
"path": "http://192.168.1.10:7000"
}]
```
##########
File path: source/adminguide/ui.rst
##########
@@ -273,6 +280,47 @@ Some assorted primary theme colours:
- Green: #52C41A
- Purple: #722ED1
+Contextual help documentation URLs can be customized with the help of `docBase` and `docHelpMappings` properties.
+A list of documentation help suffixes in code can be obtained using following command:
+
+.. parsed-literal::
+
+ grep -rnw cloudstack/ui/src/config/section -e 'docHelp:'
+
+Below example shows configuration changes for custom documentation help URLs:
+
+.. parsed-literal::
+
+ {
+ ...
+ "docBase": http://mycustomwebsite.com,
+ ...
+ "docHelpMappings": {
+ "adminguide/virtual_machines.html": "custom_vm_page.html",
+ "adminguide/templates.html": "custom_templates_page.html"
+ },
+ ...
+ }
+
+UI also provides option to show custom plugins by displaying a custom HTML page or service in an iframe. Such plugins can be listed in the config file using `plugins` property.
+Example for adding a custom plugin:
+
+.. parsed-literal::
+
+ {
+ ...
+ plugins: [
+ {
+ "name": "ExamplePlugin",
+ "icon": "appstore",
+ "path": "example.html"
Review comment:
@shwstppr can you add another example, where the path is an external URL; for example:
```
"plugins": [{
"name": "External Link Example",
"icon": "hdd",
"path": "http://example.com/portal"
}]
```
--
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
[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details
Posted by GitBox <gi...@apache.org>.
blueorangutan commented on pull request #199:
URL: https://github.com/apache/cloudstack-documentation/pull/199#issuecomment-811716334
@rhtyd a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.
--
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