-
Notifications
You must be signed in to change notification settings - Fork 303
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.
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
Doc Features: Repository #353
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the structure from #255, you have described "add new repo" piece, which is fine. However, it is better to describe the purpose of whole "Repository" section first, with screenshot of where you find it in the main menu. It is also useful linking the Helm's doc on what are repositories (this one https://helm.sh/docs/topics/chart_repository/).
Then, when reader has discovered the top-level concept, you proceed with describing how to add repository, how to update and remove it. How to filter the available charts list and how to proceed with installing one (but not describe the install process which will have an own section).
As for "add repository" description, it is a bit slim. It would be better to explain in words that user needs to provide repository name and URL, and optional username and password. Just a tiny bit more elaborate and elegant description.
Let's improve it!
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## main #353 +/- ##
=======================================
Coverage ? 29.82%
=======================================
Files ? 10
Lines ? 1321
Branches ? 0
=======================================
Hits ? 394
Misses ? 888
Partials ? 39 ☔ View full report in Codecov by Sentry. |
@undera The changes I have made are not correct? |
If you want to remove your repository from the Helm dashboard, click on the 'Remove' button as shown in the figure. | ||
![Repository5](images/screenshot_repository5.png) | ||
|
||
Use the filter option to find the desired chart quicker from the list of charts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now it looks fine. The whole section just misses the item about how to trigger chart install (by hovering the desired chart and clicking "install".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok I am on it
Very nice @pushker001 |
Helps user to understand the features of Helm-dashboard
#255