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

Add Helm Chart README to catalog page sidebar #4828

Merged
merged 2 commits into from Apr 16, 2020
Merged

Add Helm Chart README to catalog page sidebar #4828

merged 2 commits into from Apr 16, 2020

Conversation

rohitkrai03
Copy link
Contributor

@rohitkrai03 rohitkrai03 commented Mar 26, 2020 •
edited

Fixes: https://issues.redhat.com/browse/ODC-3266

Analysis / Root cause:
Currently in the Catalog, there is no way to better understand a Helm Chart before installing it.

Solution Description:
In order to give users more information about a Helm Chart we fetch the chart data from backend and show the decoded README file of that chart in markdown view in the sidebar of catalog page.

Screen shots / Gifs for design review:
cc: @openshift/team-ux-review

Readme

Test setup:
We only have one chart in our catalog right now. For testing replace the URL on line 341 of catalog-page.tsx with https://raw.githubusercontent.com/IBM/charts/master/repo/community/index.yaml.

Browser conformance:

  • Chrome
  • Firefox
  • Safari
  • Edge

dtaylor113
dtaylor113 approved these changes Mar 26, 2020
View reviewed changes
Copy link
Contributor

@dtaylor113 dtaylor113 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not that familiar with the content but code lgtm

@rohitkrai03
Copy link
Contributor Author

/retest

@andrewballantyne
Copy link
Contributor

/kind feature

@openshift-ci-robot openshift-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 26, 2020
@christianvogt
Copy link
Contributor

/hold for UX design

@openshift-ci-robot openshift-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 30, 2020
serenamarie125
serenamarie125 suggested changes Mar 31, 2020
View reviewed changes
Copy link
Contributor

@serenamarie125 serenamarie125 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rohitkrai03 please change this to match the design. We should include a Dependencies section under Description which includes the contents of the requirements.yaml. Below that, include a Readme section which includes a link to the README.md.

This was the initial UX proposal, and we have had review meetings with 2 groups of developer advocates who agreed that it's better to link out to that file rather than embed all the content.

@rohitkrai03 rohitkrai03 force-pushed the helm-readme branch 2 times, most recently from 4372959 to 3fb60eb Compare April 16, 2020 16:04
@rohitkrai03
Copy link
Contributor Author

/hold cancel

@openshift-ci-robot openshift-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 16, 2020
@rohitkrai03
Copy link
Contributor Author

rohitkrai03 commented Apr 16, 2020 •
edited

@serenamarie125 @parvathyvr Updated the PR with latest changes. Please have a look.

Readme

@rohitkrai03
Copy link
Contributor Author

/retest

@rohitkrai03
Copy link
Contributor Author

/retest

@christianvogt
Copy link
Contributor

/lgtm
/approve

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2020
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christianvogt, dtaylor113, rohitkrai03

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 16, 2020
@openshift-merge-robot openshift-merge-robot merged commit 106bc59 into openshift:master Apr 16, 2020
@spadgett spadgett added this to the v4.5 milestone Apr 20, 2020
@rohitkrai03 rohitkrai03 deleted the helm-readme branch July 24, 2021 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christianvogt christianvogt christianvogt left review comments

@abhinandan13jan abhinandan13jan abhinandan13jan left review comments

@serenamarie125 serenamarie125 serenamarie125 requested changes

@dtaylor113 dtaylor113 dtaylor113 approved these changes

@jcaianirh jcaianirh Awaiting requested review from jcaianirh

Assignees

@christianvogt christianvogt

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. component/core Related to console core functionality kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
v4.5
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@rohitkrai03 @andrewballantyne @christianvogt @openshift-ci-robot @serenamarie125 @dtaylor113 @abhinandan13jan @spadgett @openshift-merge-robot