Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Access from the UI #2149

Closed
thomasdanan opened this issue Dec 18, 2019 · 0 comments · Fixed by #2176
Closed

Documentation Access from the UI #2149

thomasdanan opened this issue Dec 18, 2019 · 0 comments · Fixed by #2176
Assignees
@ChengYanJin
Labels
complexity:easy Something that requires less than a day to fix topic:docs Documentation topic:ui UI-related issues
Milestone
MetalK8s 2.4.2

Comments

@thomasdanan
Copy link
Contributor

Component:

'ui', 'documentation'

Why this is needed:

Since we are going to embed html documentation in UI container (#1595), we would like to have a short and easy link from MetalK8s UI to the HTML documentation

What should be done:

  • Have an entry in the top bar to access the documentation. When the user click on the link, documentation is opened in a new tab
  • Have a short link in the Volume Creation page to directly access the Volume Creation section in the doc. Ideally in the top right corner of the page
  • Just next to the storage class combo, it would be great to have a little question mark that opens storage class documentation section in a new tab. The same short link could be available from the banner saying no storage class is available (but I don't see when this case could happen)

Implementation proposal (strongly recommended):

Test plan:
@thomasdanan thomasdanan added topic:docs Documentation moonshot topic:ui UI-related issues labels Dec 18, 2019
@thomasdanan thomasdanan added this to the MetalK8s 2.4.2 milestone Dec 18, 2019
@ChengYanJin ChengYanJin self-assigned this Jan 3, 2020
@ChengYanJin ChengYanJin added the complexity:easy Something that requires less than a day to fix label Jan 3, 2020
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: access docs from UI
2888830 
- 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
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add translations
dee159d 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
bb99f32 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
3ab2098 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add translations
380d558 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
055f683 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
c87caf8 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
455ec95 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
7567c76 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
9e21721 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
a384e91 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
@ChengYanJin ChengYanJin mentioned this issue Jan 6, 2020
Merged
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add translations
bb1e607 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
944ae40 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 6, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
4beacab 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: add translations
1ceb630 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
273899d 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
e42f51b 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: access docs from UI
98b9555 
- 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
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: add translations
7d33d0d 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
888b430 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 7, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
58f4b65 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 8, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
02aea9a 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 8, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
54ea296 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 8, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
baf7978 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 8, 2020
@ChengYanJin
ui/doc: fix the bug when the content of tooltip is empty but still di…
fdca4df 
…splay

- the bug was imported by adding the <TooltipContent> style

Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 9, 2020
@ChengYanJin
ui/doc: add url_doc into the configMap
6daca82 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 9, 2020
@ChengYanJin
ui/doc: add url_doc inside the configMap
bac129a 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 11, 2020
@ChengYanJin
ui/doc: add cypress test for the documentation link
1897721 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 11, 2020
@ChengYanJin
ui/doc: add cypress test for the documentation link
57d01b7 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 13, 2020
@ChengYanJin
ui/doc: add cypress test for the documentation link
5ae9690 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 14, 2020
@ChengYanJin
ui/doc: add cypress test for the documentation link
ff32b3f 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
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
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
ui/doc: add translations
9a90841 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
ui/doc: add a link to documentaion for volume creation
8e1a852 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
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
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
ui/doc: add url_doc inside the configMap
7a4a611 
Refs: #2149
ChengYanJin added a commit that referenced this issue Jan 15, 2020
@ChengYanJin
ui/doc: add cypress test for the documentation link
5d51fd9 
Refs: #2149
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChengYanJin ChengYanJin

Labels
complexity:easy Something that requires less than a day to fix topic:docs Documentation topic:ui UI-related issues
Projects
None yet
Milestone
MetalK8s 2.4.2
Development

Successfully merging a pull request may close this issue.

Improvement/2149 documentation access from the ui scality/metalk8s
2 participants
@ChengYanJin @thomasdanan