ui: allow docHelp override using config.json by shwstppr · Pull Request #4745 · apache/cloudstack

shwstppr · 2021-03-03T07:49:34Z

Description

config.json can have a property named 'docHelpMappings' which can be used to override docHelp suffixes.
In config.json admin can add mappings as follows:

...
"docHelpMappings": {
  "virtual_machines.html": "some.html",
  "some_string": "override_string"
}

UI will use these mappings and will make appropriate replacements in the documentation links for different sections and forms.

Addresses #4731
Documentation PR: apache/cloudstack-documentation#199

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Made changes in config.json

...
  "docHelpMappings": {
    "virtual_machines.html": "page1.html",
    "templates.html": "page2.html"
  }

yadvr · 2021-03-03T08:05:11Z

@blueorangutan ui

blueorangutan · 2021-03-03T08:05:37Z

@rhtyd a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

config.json can have a property named 'docHelpMappings' which can be used to override docHelp suffixes. In config.json admin can add mappings as follows: "docHelpMappings": { "virtual_machine.html": "some.html", "some_string": "override_string" } UI will use these mappings and will make appropriate replacements in the documentation links for different sections and forms. Addresses apache#4731 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

blueorangutan · 2021-03-03T08:11:31Z

UI build: ✔️
Live QA URL: http://qa.cloudstack.cloud:8080/client/pr/4745 (JID-3846)

shwstppr · 2021-03-03T08:12:51Z

@blueorangutan ui

blueorangutan · 2021-03-03T08:13:37Z

@shwstppr a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2021-03-03T08:18:57Z

UI build: ✔️
Live QA URL: http://qa.cloudstack.cloud:8080/client/pr/4745 (JID-3847)

utchoang

LGTM

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2021-03-15T06:47:02Z

@blueorangutan ui

blueorangutan · 2021-03-15T06:48:03Z

@shwstppr a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress. [S]

shwstppr · 2021-03-15T06:48:05Z

@rhtyd moved overriding call in router.js and ActionButton.vue. Working fine. Please check

blueorangutan · 2021-03-15T06:54:05Z

UI build: ✔️
Live QA URL: http://qa.cloudstack.cloud:8080/client/pr/4745 (SL-JID-24)

yadvr · 2021-03-18T07:53:44Z

LGTM I need to test this manually before merging, are the upstream doc PR raised @shwstppr (to https://github.com/apache/cloudstack-documentation ?)

shwstppr · 2021-03-18T07:55:18Z

apache/cloudstack-documentation#199 @rhtyd

yadvr · 2021-03-24T07:03:14Z

@blueorangutan ui

blueorangutan · 2021-03-24T07:04:03Z

@rhtyd a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2021-03-24T07:14:10Z

UI build: ✔️
Live QA URL: http://qa.cloudstack.cloud:8080/client/pr/4745 (SL-JID-56)

yadvr · 2021-04-01T07:40:17Z

Manually tested - LGTM

  "docHelpMappings": {
    "adminguide/virtual_machines.html": "conceptsandterminology/index.html"
  },

shwstppr marked this pull request as draft March 3, 2021 07:55

shwstppr force-pushed the add-dochelpmappings-config branch from 4b86656 to ad99722 Compare March 3, 2021 08:02

yadvr added this to the 4.15.1.0 milestone Mar 3, 2021

yadvr approved these changes Mar 3, 2021

View reviewed changes

shwstppr force-pushed the add-dochelpmappings-config branch from ad99722 to d9729bc Compare March 3, 2021 08:12

shwstppr marked this pull request as ready for review March 3, 2021 08:12

shwstppr linked an issue Mar 3, 2021 that may be closed by this pull request

UI: Create help doc mapping via config.json #4731

Closed

shwstppr mentioned this pull request Mar 3, 2021

UI: Create help doc mapping via config.json #4731

Closed

shwstppr added the component:UI label Mar 3, 2021

yadvr requested a review from utchoang March 6, 2021 09:39

utchoang approved these changes Mar 10, 2021

View reviewed changes

yadvr and others added 3 commits March 11, 2021 13:10

Update config.json

430e7a2

refactor

d17abe5

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

fix

608f253

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr mentioned this pull request Mar 16, 2021

ui: added customization details apache/cloudstack-documentation#199

Merged

yadvr assigned yadvr and davidjumani Mar 24, 2021

yadvr merged commit 2513683 into apache:4.15 Apr 1, 2021

Conversation

shwstppr commented Mar 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

yadvr commented Mar 3, 2021

Uh oh!

blueorangutan commented Mar 3, 2021

Uh oh!

blueorangutan commented Mar 3, 2021

Uh oh!

shwstppr commented Mar 3, 2021

Uh oh!

blueorangutan commented Mar 3, 2021

Uh oh!

blueorangutan commented Mar 3, 2021

Uh oh!

utchoang left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Mar 15, 2021

Uh oh!

blueorangutan commented Mar 15, 2021

Uh oh!

shwstppr commented Mar 15, 2021

Uh oh!

blueorangutan commented Mar 15, 2021

Uh oh!

yadvr commented Mar 18, 2021

Uh oh!

shwstppr commented Mar 18, 2021

Uh oh!

yadvr commented Mar 24, 2021

Uh oh!

blueorangutan commented Mar 24, 2021

Uh oh!

blueorangutan commented Mar 24, 2021

Uh oh!

yadvr commented Apr 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

shwstppr commented Mar 3, 2021 •

edited

Loading