Skip to content

Doc Features: Repository - #353

Merged
undera merged 5 commits into
komodorio:mainfrom
pushker001:docs
May 15, 2023
Merged

undera merged 5 commits into
komodorio:mainfrom
pushker001:docs

Conversation

@pushker001

Copy link
Copy Markdown
Contributor

Helps user to understand the features of Helm-dashboard
#255

  • The title of my pull request is a short description of the changes
  • This PR relates to some issue:

@undera undera left a comment

Copy link
Copy Markdown
Collaborator

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-commenter

Copy link
Copy Markdown

Codecov Report

❗ No coverage uploaded for pull request base (main@d225924). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ 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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@pushker001

pushker001 commented May 11, 2023 •

Copy link
Copy Markdown
Contributor Author

@undera The changes I have made are not correct?

Comment thread FEATURES.md Resolved
Comment thread FEATURES.md Resolved
Comment thread FEATURES.md
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.

Copy link
Copy Markdown
Collaborator

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".

Copy link
Copy Markdown
Contributor Author

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

@undera

undera commented May 15, 2023

Copy link
Copy Markdown
Collaborator

Very nice @pushker001

@undera
undera merged commit e143963 into komodorio:main May 15, 2023
@pushker001
pushker001 deleted the docs branch May 15, 2023 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

⌂ 换网址