Improvement/2149 documentation access from the ui #2176

ChengYanJin · 2020-01-06T15:52:50Z

Component: ui, doc

Context:
We would like to access the doc from UI.

Summary:

Add the documentation entry point from the Navbar
Add the link in the volume creation page
Change the icon in clusterMonistering page ( question icon => infomation icon)
Fix bugs for create volume list

Acceptance criteria:
Add the link in the volume creation page and add the documentation entry point from the Navbar:

should pass the cypress test:
./node_modules/cypress/bin/cypress run -b chrome -s cypress/integration/AccessDocumentation.feature

Closes: #2149

The integration branch in 2.5 is:
w/2.5/improvement/2149-documentation-access-from-the-UI

bert-e · 2020-01-06T15:52:53Z

Hello chengyanjin,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

bert-e · 2020-01-06T15:52:58Z

Conflict

A conflict has been raised during the creation of
integration branch w/2.5/improvement/2149-documentation-access-from-the-UI with contents from improvement/2149-documentation-access-from-the-UI
and development/2.5.

I have not created the integration branch.

Here are the steps to resolve this conflict:

 $ git fetch
 $ git checkout -B w/2.5/improvement/2149-documentation-access-from-the-UI origin/development/2.5
 $ git merge origin/improvement/2149-documentation-access-from-the-UI
 $ # <intense conflict resolution>
 $ git commit
 $ git push -u origin w/2.5/improvement/2149-documentation-access-from-the-UI

bert-e · 2020-01-06T16:30:26Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

ui/src/translations/en.json

bert-e · 2020-01-07T09:20:48Z

History mismatch

Merge commit #bb1e6074de5eae475d7c965682ffc9a269acd77f on the integration branch
w/2.5/improvement/2149-documentation-access-from-the-UI is merging a branch which is neither the current
branch improvement/2149-documentation-access-from-the-UI nor the development branch
development/2.5.

It is likely due to a rebase of the branch improvement/2149-documentation-access-from-the-UI and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

ChengYanJin · 2020-01-07T09:21:12Z

/reset

bert-e · 2020-01-07T09:21:19Z

Reset complete

I have successfully deleted this pull request's integration branches.

bert-e · 2020-01-07T09:21:25Z

Conflict

A conflict has been raised during the creation of
integration branch w/2.5/improvement/2149-documentation-access-from-the-UI with contents from improvement/2149-documentation-access-from-the-UI
and development/2.5.

I have not created the integration branch.

Here are the steps to resolve this conflict:

 $ git fetch
 $ git checkout -B w/2.5/improvement/2149-documentation-access-from-the-UI origin/development/2.5
 $ git merge origin/improvement/2149-documentation-access-from-the-UI
 $ # <intense conflict resolution>
 $ git commit
 $ git push -u origin w/2.5/improvement/2149-documentation-access-from-the-UI

bert-e · 2020-01-07T10:17:25Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

bert-e · 2020-01-07T17:13:01Z

History mismatch

Merge commit #2888830e6c798cd865817e27ce88ec068443e0d9 on the integration branch
w/2.5/improvement/2149-documentation-access-from-the-UI is merging a branch which is neither the current
branch improvement/2149-documentation-access-from-the-UI nor the development branch
development/2.5.

It is likely due to a rebase of the branch improvement/2149-documentation-access-from-the-UI and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

ChengYanJin · 2020-01-08T08:48:33Z

/reset

bert-e · 2020-01-08T08:48:40Z

Reset complete

I have successfully deleted this pull request's integration branches.

bert-e · 2020-01-08T08:48:46Z

Conflict

A conflict has been raised during the creation of
integration branch w/2.5/improvement/2149-documentation-access-from-the-UI with contents from improvement/2149-documentation-access-from-the-UI
and development/2.5.

I have not created the integration branch.

Here are the steps to resolve this conflict:

 $ git fetch
 $ git checkout -B w/2.5/improvement/2149-documentation-access-from-the-UI origin/development/2.5
 $ git merge origin/improvement/2149-documentation-access-from-the-UI
 $ # <intense conflict resolution>
 $ git commit
 $ git push -u origin w/2.5/improvement/2149-documentation-access-from-the-UI

slaperche-scality · 2020-01-08T09:00:24Z

ui/src/containers/ClusterMonitoring.js

@@ -222,7 +222,7 @@ const ClusterMonitoring = props => {
              </TooltipContent>
            }
          >
-            <QuestionMarkIcon className="fas fa-question-circle" />
+            <QuestionMarkIcon className="fas fa-info-circle" />


Not related to this PR (and can't be fixed here, I supposed it's coming from core-ui), but the naming seems poor to me: we call QuestionMarkIcon something that's not always a question mark icon…

Forgot to change the name QuestionMarkIcon to InformationMarkIcon, my bad.
Sure, it's not related to this PR, but it's a tiny change in order to keep the consistency for the icons.
And just FYI, the icon we import directly from the font-awsome library ;)

gdemonet

Code LGTM, will test soon :)

bert-e · 2020-01-14T10:43:56Z

Reset complete

I have successfully deleted this pull request's integration branches.

The following options are set: create_pull_requests

bert-e · 2020-01-14T10:44:03Z

Conflict

A conflict has been raised during the creation of
integration branch w/2.5/improvement/2149-documentation-access-from-the-UI with contents from improvement/2149-documentation-access-from-the-UI
and development/2.5.

I have not created the integration branch.

Here are the steps to resolve this conflict:

 $ git fetch
 $ git checkout -B w/2.5/improvement/2149-documentation-access-from-the-UI origin/development/2.5
 $ git merge origin/improvement/2149-documentation-access-from-the-UI
 $ # <intense conflict resolution>
 $ git commit
 $ git push -u origin w/2.5/improvement/2149-documentation-access-from-the-UI

The following options are set: create_pull_requests

ChengYanJin · 2020-01-14T13:01:05Z

/status

bert-e · 2020-01-14T13:01:09Z

Status

Status report is not available.

The following options are set: create_pull_requests

bert-e · 2020-01-14T13:01:18Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge improvement/2149-documentation-access-from-the-UI into
development/2.4
w/2.5/improvement/2149-documentation-access-from-the-UI will be merged into development/2.5 (pull request INTEGRATION [PR#2176 > development/2.5] Improvement/2149 documentation access from the ui #2185)

The following branches will NOT be impacted:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3

Follow integration pull requests if you would like to be notified of
build statuses by email.

The following options are set: create_pull_requests

bert-e · 2020-01-14T13:01:19Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

The following options are set: create_pull_requests

gdemonet

LGTM

- We can access the docs from navbar->help->documentaion - When there is no storage class, access the storage class creation doc from Banner - Add a question mark icon next to the storage class Refs: #2149

Refs: #2149

…splay - the bug was imported by adding the <TooltipContent> style Refs: #2149

We want to keep the consistency of the icon. since we already have quesion icon in the navbar, it should be better we use another icon.

Refs: #2149

bert-e · 2020-01-15T16:56:36Z

History mismatch

Merge commit #98b9555192a785020db5d0d1a03f5a3954181740 on the integration branch
w/2.5/improvement/2149-documentation-access-from-the-UI is merging a branch which is neither the current
branch improvement/2149-documentation-access-from-the-UI nor the development branch
development/2.5.

It is likely due to a rebase of the branch improvement/2149-documentation-access-from-the-UI and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

The following options are set: create_pull_requests

ChengYanJin · 2020-01-16T08:27:37Z

/reset

bert-e · 2020-01-16T08:27:54Z

Reset complete

I have successfully deleted this pull request's integration branches.

The following options are set: create_pull_requests

bert-e · 2020-01-16T08:28:00Z

Conflict

A conflict has been raised during the creation of
integration branch w/2.5/improvement/2149-documentation-access-from-the-UI with contents from improvement/2149-documentation-access-from-the-UI
and development/2.5.

I have not created the integration branch.

Here are the steps to resolve this conflict:

 $ git fetch
 $ git checkout -B w/2.5/improvement/2149-documentation-access-from-the-UI origin/development/2.5
 $ git merge origin/improvement/2149-documentation-access-from-the-UI
 $ # <intense conflict resolution>
 $ git commit
 $ git push -u origin w/2.5/improvement/2149-documentation-access-from-the-UI

The following options are set: create_pull_requests

bert-e · 2020-01-16T08:58:51Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge improvement/2149-documentation-access-from-the-UI into
development/2.4
w/2.5/improvement/2149-documentation-access-from-the-UI will be merged into development/2.5 (pull request INTEGRATION [PR#2176 > development/2.5] Improvement/2149 documentation access from the ui #2194)

The following branches will NOT be impacted:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3

Follow integration pull requests if you would like to be notified of
build statuses by email.

The following options are set: create_pull_requests

bert-e · 2020-01-16T08:58:53Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

The following options are set: create_pull_requests

ChengYanJin · 2020-01-17T09:09:43Z

/approve

bert-e · 2020-01-17T09:09:56Z

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

✔️ development/2.4
✔️ development/2.5

The following branches will NOT be impacted:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

Any commit you add on the source branch will trigger a new cycle after the
current queue is merged.
Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: create_pull_requests, approve

bert-e · 2020-01-18T14:17:47Z

I have successfully merged the changeset of this pull request
into targetted development branches:

✔️ development/2.4
✔️ development/2.5

The following branches have NOT changed:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3

Please check the status of the associated issue None.

Goodbye chengyanjin.

ChengYanJin added topic:docs Documentation topic:ui UI-related issues labels Jan 6, 2020

ChengYanJin requested review from thomasdanan, gdemonet and carlito-scality January 6, 2020 15:52

ChengYanJin requested a review from a team as a code owner January 6, 2020 15:52

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch from a384e91 to 4beacab Compare January 6, 2020 15:58

slaperche-scality reviewed Jan 7, 2020

View reviewed changes

ui/src/translations/en.json Outdated Show resolved Hide resolved

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch from 4beacab to e42f51b Compare January 7, 2020 09:20

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch from e42f51b to 5213adb Compare January 7, 2020 17:12

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch 2 times, most recently from 169a223 to 592c7f7 Compare January 8, 2020 08:47

ChengYanJin requested a review from slaperche-scality January 8, 2020 08:47

slaperche-scality reviewed Jan 8, 2020

View reviewed changes

gdemonet reviewed Jan 8, 2020

View reviewed changes

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch from 592c7f7 to 1342a01 Compare January 8, 2020 14:38

bert-e mentioned this pull request Jan 14, 2020

INTEGRATION [PR#2176 > development/2.5] Improvement/2149 documentation access from the ui #2185

Closed

gdemonet previously approved these changes Jan 14, 2020

View reviewed changes

ChengYanJin added 7 commits January 15, 2020 17:56

ui/doc: access docs from UI

ca26c56

- We can access the docs from navbar->help->documentaion - When there is no storage class, access the storage class creation doc from Banner - Add a question mark icon next to the storage class Refs: #2149

ui/doc: add translations

9a90841

Refs: #2149

ui/doc: add a link to documentaion for volume creation

8e1a852

Refs: #2149

ui/doc: fix the bug when the content of tooltip is empty but still di…

019576a

…splay - the bug was imported by adding the <TooltipContent> style Refs: #2149

ui/doc: change the cluster status icon from question to info

b4236cd

We want to keep the consistency of the icon. since we already have quesion icon in the navbar, it should be better we use another icon.

ui/doc: add url_doc inside the configMap

7a4a611

Refs: #2149

ui/doc: add cypress test for the documentation link

5d51fd9

Refs: #2149

ChengYanJin dismissed gdemonet’s stale review via 5d51fd9 January 15, 2020 16:56

ChengYanJin force-pushed the improvement/2149-documentation-access-from-the-UI branch from 5ae9690 to 5d51fd9 Compare January 15, 2020 16:56

bert-e mentioned this pull request Jan 16, 2020

INTEGRATION [PR#2176 > development/2.5] Improvement/2149 documentation access from the ui #2194

Merged

gdemonet approved these changes Jan 17, 2020

View reviewed changes

bert-e merged commit 5d51fd9 into development/2.4 Jan 18, 2020

bert-e deleted the improvement/2149-documentation-access-from-the-UI branch January 18, 2020 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvement/2149 documentation access from the ui #2176

Improvement/2149 documentation access from the ui #2176

ChengYanJin commented Jan 6, 2020 •

edited

Loading

bert-e commented Jan 6, 2020

bert-e commented Jan 6, 2020

bert-e commented Jan 6, 2020

bert-e commented Jan 7, 2020

ChengYanJin commented Jan 7, 2020

bert-e commented Jan 7, 2020

bert-e commented Jan 7, 2020

bert-e commented Jan 7, 2020

bert-e commented Jan 7, 2020

ChengYanJin commented Jan 8, 2020

bert-e commented Jan 8, 2020

bert-e commented Jan 8, 2020

slaperche-scality Jan 8, 2020

ChengYanJin Jan 8, 2020

gdemonet left a comment

bert-e commented Jan 14, 2020

bert-e commented Jan 14, 2020

ChengYanJin commented Jan 14, 2020

bert-e commented Jan 14, 2020

bert-e commented Jan 14, 2020

bert-e commented Jan 14, 2020

gdemonet left a comment

bert-e commented Jan 15, 2020

ChengYanJin commented Jan 16, 2020

bert-e commented Jan 16, 2020

bert-e commented Jan 16, 2020

bert-e commented Jan 16, 2020

bert-e commented Jan 16, 2020

ChengYanJin commented Jan 17, 2020

bert-e commented Jan 17, 2020

bert-e commented Jan 18, 2020

Improvement/2149 documentation access from the ui #2176

Improvement/2149 documentation access from the ui #2176

Conversation

ChengYanJin commented Jan 6, 2020 • edited Loading

bert-e commented Jan 6, 2020

Hello chengyanjin,

bert-e commented Jan 6, 2020

Conflict

bert-e commented Jan 6, 2020

Waiting for approval

bert-e commented Jan 7, 2020

History mismatch

ChengYanJin commented Jan 7, 2020

bert-e commented Jan 7, 2020

Reset complete

bert-e commented Jan 7, 2020

Conflict

bert-e commented Jan 7, 2020

Waiting for approval

bert-e commented Jan 7, 2020

History mismatch

ChengYanJin commented Jan 8, 2020

bert-e commented Jan 8, 2020

Reset complete

bert-e commented Jan 8, 2020

Conflict

slaperche-scality Jan 8, 2020

Choose a reason for hiding this comment

ChengYanJin Jan 8, 2020

Choose a reason for hiding this comment

gdemonet left a comment

Choose a reason for hiding this comment

bert-e commented Jan 14, 2020

Reset complete

bert-e commented Jan 14, 2020

Conflict

ChengYanJin commented Jan 14, 2020

bert-e commented Jan 14, 2020

Status

bert-e commented Jan 14, 2020

Integration data created

bert-e commented Jan 14, 2020

Waiting for approval

gdemonet left a comment

Choose a reason for hiding this comment

bert-e commented Jan 15, 2020

History mismatch

ChengYanJin commented Jan 16, 2020

bert-e commented Jan 16, 2020

Reset complete

bert-e commented Jan 16, 2020

Conflict

bert-e commented Jan 16, 2020

Integration data created

bert-e commented Jan 16, 2020

Waiting for approval

ChengYanJin commented Jan 17, 2020

bert-e commented Jan 17, 2020

In the queue

bert-e commented Jan 18, 2020

ChengYanJin commented Jan 6, 2020 •

edited

Loading