Doc Feature: Installed Releases List #356
Conversation
Helps user to know the features of Helm-Dashboard
FEATURES.md
Outdated
|
|
||
| # Installed Releases list | ||
| This tells us which chart version we are using. |
There was a problem hiding this comment.
In terminology of Helm, that list is list of releases installed. Try to describe this "list of releases" idea a bit better. This includes describing the filtering by namespace and filtering by text.
FEATURES.md
Outdated
|  | ||
|
|
||
| This indicates the time when your chart was last updated. |
There was a problem hiding this comment.
It's a list of releases, not charts. Once you install chart, it becomes a release.
|
If your PR is "work in progress" - convert it into "Draft", that's a feature of GitHub. |
|
@undera Is it okay now or any correction is needed? |
FEATURES.md
Outdated
|
|
||
| # Installed Releases list | ||
| This informs us about the release version we are currently using. You can utilize the filter option to refine your search for a specific release by employing namespaces and freetext. |
There was a problem hiding this comment.
It's a bit misleading. You are talking about "release version", while the list is just list of releases. You also don't show good list of several releases installed, don't point to namespaces and text filter in UI.
Your description should have more structured approach: first explain the purpose of the list of multiple releases and general filtering, then explain the contains of list rows.
Try installing more releases from "repository" section, entering different namespaces in each, to get more representative picture in UI.
There was a problem hiding this comment.
Probably I'm confused with general list description totally missing and you just described the pieces of each row. Then, we need to add that general description in the beginning.
Also, we need to describe couple of special situations regarding chart version, one is when there is an version upgrade available, another is when repository is detected for that release.
FEATURES.md
Outdated
|
|
||
| This indicates the time when your release was last updated. | ||
|  |
There was a problem hiding this comment.
The description does not mention the status of release and health status of its corresponding resources. You should install some chart like argo-workflows from bitnami to see more impressive resource indicator.
FEATURES.md
Outdated
| The squares represent k8s resources installed by the release. Hover over each square to view a tooltip with details. Yellow indicates "pending," green signifies a healthy state, and red indicates an unhealthy state. | ||
|  | ||
|
|
||
| This indicates the list of releases and the corresponding chart versions. |
There was a problem hiding this comment.
The overall flow is a bit strange - you speak about the list, then about squares inside individual rows, then about the list again.
I suggest you to describe it more structurally - first about list as a whole, then about what each item in list contains.
There was a problem hiding this comment.
@undera "In list as a whole" what you want can you be more specific
First I describe what is release and the purpose of release then I tell you can search release using a text filter and namespace and then I explain individually row as you told me to do
There was a problem hiding this comment.
Here's the structure of product:
Level 1: Page
Level 2: List of installed releases, filter by namespace, filter by text
Level 3: Each item of the list displays: name, status, age etc.
Right now this logic is not followed. You talk about level 2, then one item of level 3, then level 2 again, then level 3 again. It would confuse the reader a lot.
| # Installed Releases list | ||
| A release is an instance of your selected chart running on your Kubernetes Cluster. That means every time that you install a Helm chart there, it creates a new release or instance that coexists with other releases without conflict. You can filter releases based on namespaces or search for release names | ||
|  |
There was a problem hiding this comment.
@undera Is this part is okay or I need to add something in this part?
There was a problem hiding this comment.
This piece is ok, the problem is described below.
Codecov ReportPatch and project coverage have no change.
❗ 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 #356 +/- ##
=======================================
Coverage 29.82% 29.82%
=======================================
Files 10 10
Lines 1321 1321
=======================================
Hits 394 394
Misses 888 888
Partials 39 39 ☔ View full report in Codecov by Sentry. |
|
@undera I have done changes |
|
Thanks! Let's improve from here. |
Helps users to know the features of Helm-Dashboard
CheckList