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

[GitBox]

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

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

[GitBox]

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

Re: [RESULT][VOTE] Renaming default git branch name from 'master' to 'main' and replace offensive words as appropriate for inclusiveness

[Suresh Anaparti]

FYI. A language scanner for inclusive terminology is being proposed in Apache 
Diversity. A demo scanner service for CloudStack repo here: 
https://clcdemo.net/analysis.html?project=cloudstack.git

I hope CloudStack counters will go down, after merging the renaming/inclusive 
PRs.

Regards,
Suresh

On 11/05/21, 1:12 PM, "Suresh Anaparti"  wrote:

Hi all,

The vote [1] for renaming default git branch name from 'master' to 'main' 
and replace offensive words as appropriate for inclusiveness, in the Apache 
CloudStack project has passed with the following votes:

+1 (PMC / binding)
4 persons (Daan, Gabriel, Rohit, Wei)

+1 (non-binding)
5 persons (David, Rene, Nathan, Hari, Suresh)

+0
1 person (Andrija)

Thank you all for participating. Next steps, I'll close any review feedback 
on the PRs and get them accepted. Once the PRs are accepted, we can merge them 
to 'master' (may be after 4.15.1 release) and will request ASF infra (track 
through new INFRA ticket) to disable pushes to 'master', rename 'master' to 
'main and set 'main' as the default branch, for all the CloudStack repos.

[1] https://markmail.org/message/n6sbl3vgm7hy77zj


Regards,
Suresh






 

[GitHub] [cloudstack-kubernetes-provider] rhtyd merged pull request #29: Inclusivity changes for CloudStack - rename some offensive words/terms as appropriate, that are meaningful and inclusive.

[GitBox]

rhtyd merged pull request #29:
URL: https://github.com/apache/cloudstack-kubernetes-provider/pull/29


   


-- 
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

[GitHub] [cloudstack-ec2stack] rhtyd merged pull request #2: Inclusivity changes for CloudStack - rename some offensive words/terms as appropriate, that are meaningful and inclusive.

[GitBox]

rhtyd merged pull request #2:
URL: https://github.com/apache/cloudstack-ec2stack/pull/2


   


-- 
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

[GitHub] [cloudstack-gcestack] rhtyd merged pull request #3: Inclusivity changes for CloudStack - rename some offensive words/terms as appropriate, that are meaningful and inclusive.

[GitBox]

rhtyd merged pull request #3:
URL: https://github.com/apache/cloudstack-gcestack/pull/3


   


-- 
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

[GitHub] [cloudstack-www] rhtyd commented on pull request #83: Inclusivity changes for CloudStack - Renamed default git branch name from 'master' to 'main', and some offensive words/terms as appropria

[GitBox]

rhtyd commented on pull request #83:
URL: https://github.com/apache/cloudstack-www/pull/83#issuecomment-845815731


   Merging this but we won't update the website (asf-site branch) until the 
main repo's branch is change to `main`


-- 
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

[GitHub] [cloudstack-www] rhtyd merged pull request #83: Inclusivity changes for CloudStack - Renamed default git branch name from 'master' to 'main', and some offensive words/terms as appropriate.

[GitBox]

rhtyd merged pull request #83:
URL: https://github.com/apache/cloudstack-www/pull/83


   


-- 
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

[GitHub] [cloudstack-www] rhtyd merged pull request #81: Remove IRC reference as it is no longer used

[GitBox]

rhtyd merged pull request #81:
URL: https://github.com/apache/cloudstack-www/pull/81


   


-- 
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

[GitHub] [cloudstack-documentation] rhtyd commented on pull request #155: Inclusivity changes for CloudStack in the documentation - Rename default git branch name from 'master' to 'main' and replace

[GitBox]

rhtyd commented on pull request #155:
URL: 
https://github.com/apache/cloudstack-documentation/pull/155#issuecomment-845816755


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

[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #155: Inclusivity changes for CloudStack in the documentation - Rename default git branch name from 'master' to 'main' and

[GitBox]

blueorangutan commented on pull request #155:
URL: 
https://github.com/apache/cloudstack-documentation/pull/155#issuecomment-845817559


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

[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details

[GitBox]

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

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

[GitBox]

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

[GitHub] [cloudstack-documentation] blueorangutan commented on pull request #199: ui: added customization details

[GitBox]

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

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

[GitBox]

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

Re: [RESULT][VOTE] Renaming default git branch name from 'master' to 'main' and replace offensive words as appropriate for inclusiveness

[Sven Vogel]

Thanks Suresh. I will take a look.


__

Sven Vogel
Senior Manager Research and Development - Cloud and Infrastructure

EWERK DIGITAL GmbH
Brühl 24, D-04109 Leipzig
P +49 341 42649 - 99
F +49 341 42649 - 98
s.vo...@ewerk.com
www.ewerk.com

Geschäftsführer:
Dr. Erik Wende, Hendrik Schubert, Tassilo Möschke
Registergericht: Leipzig HRB 9065

Support:
+49 341 42649 555

Zertifiziert nach:
ISO/IEC 27001:2013
DIN EN ISO 9001:2015
DIN ISO/IEC 2-1:2018

ISAE 3402 Typ II Assessed

EWERK-Blog | 
LinkedIn | 
Xing | 
Twitter | 
Facebook


Auskünfte und Angebote per Mail sind freibleibend und unverbindlich.

Disclaimer Privacy:
Der Inhalt dieser E-Mail (einschließlich etwaiger beigefügter Dateien) ist 
vertraulich und nur für den Empfänger bestimmt. Sollten Sie nicht der 
bestimmungsgemäße Empfänger sein, ist Ihnen jegliche Offenlegung, 
Vervielfältigung, Weitergabe oder Nutzung des Inhalts untersagt. Bitte 
informieren Sie in diesem Fall unverzüglich den Absender und löschen Sie die 
E-Mail (einschließlich etwaiger beigefügter Dateien) von Ihrem System. Vielen 
Dank.

The contents of this e-mail (including any attachments) are confidential and 
may be legally privileged. If you are not the intended recipient of this 
e-mail, any disclosure, copying, distribution or use of its contents is 
strictly prohibited, and you should please notify the sender immediately and 
then delete it (including any attachments) from your system. Thank you.


Von: Suresh Anaparti 
Gesendet: Friday, May 21, 2021 11:19:38 AM
An: dev@cloudstack.apache.org ; 
priv...@cloudstack.apache.org 
Betreff: Re: [RESULT][VOTE] Renaming default git branch name from 'master' to 
'main' and replace offensive words as appropriate for inclusiveness

FYI. A language scanner for inclusive terminology is being proposed in Apache 
Diversity. A demo scanner service for CloudStack repo here: 
https://clcdemo.net/analysis.html?project=cloudstack.git

I hope CloudStack counters will go down, after merging the renaming/inclusive 
PRs.

Regards,
Suresh

On 11/05/21, 1:12 PM, "Suresh Anaparti"  wrote:

Hi all,

The vote [1] for renaming default git branch name from 'master' to 'main' 
and replace offensive words as appropriate for inclusiveness, in the Apache 
CloudStack project has passed with the following votes:

+1 (PMC / binding)
4 persons (Daan, Gabriel, Rohit, Wei)

+1 (non-binding)
5 persons (David, Rene, Nathan, Hari, Suresh)

+0
1 person (Andrija)

Thank you all for participating. Next steps, I'll close any review feedback 
on the PRs and get them accepted. Once the PRs are accepted, we can merge them 
to 'master' (may be after 4.15.1 release) and will request ASF infra (track 
through new INFRA ticket) to disable pushes to 'master', rename 'master' to 
'main and set 'main' as the default branch, for all the CloudStack repos.

[1] https://markmail.org/message/n6sbl3vgm7hy77zj


Regards,
Suresh

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

[GitBox]

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