Doc Feature: Installed Releases List #356

pushker001 · 2023-05-17T10:18:27Z

Helps users to know the features of Helm-Dashboard

CheckList

The title of my pull request is a short description of the changes
This PR relates to some issue: Document application capabilities #255

Helps user to know the features of Helm-Dashboard

undera · 2023-05-17T10:24:19Z

FEATURES.md

+
+# Installed Releases list
+This tells us which chart version we are using.


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.

undera · 2023-05-17T10:24:50Z

FEATURES.md

+![Releases3](images/screenshot_release3.png)
+
+This indicates the time when your chart was last updated.


It's a list of releases, not charts. Once you install chart, it becomes a release.

undera · 2023-05-17T10:25:35Z

If your PR is "work in progress" - convert it into "Draft", that's a feature of GitHub.

pushker001 · 2023-05-17T10:34:48Z

@undera Is it okay now or any correction is needed?

undera · 2023-05-17T10:39:40Z

FEATURES.md

+
+# 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.


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.

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.

undera · 2023-05-17T10:42:13Z

FEATURES.md

+
+This indicates the time when your release was last updated.
+![Releases4](images/screenshot_release4.png)


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.

undera · 2023-05-18T12:57:17Z

FEATURES.md

+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.
+![Releases1](images/screenshot_release1.png)
+
+This indicates the list of releases and the corresponding chart versions.


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.

@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

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.

pushker001 · 2023-05-18T16:54:02Z

FEATURES.md

+# 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 
+![Releases](images/screenshot_release.png)


@undera Is this part is okay or I need to add something in this part?

This piece is ok, the problem is described below.

codecov-commenter · 2023-05-19T09:56:44Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (e143963) 29.82% compared to head (fcc374c) 29.82%.

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

pushker001 · 2023-05-24T09:43:07Z

@undera I have done changes

undera · 2023-05-24T09:53:32Z

Thanks! Let's improve from here.

Doc Feature: Installed Releases List

0868533

Helps user to know the features of Helm-Dashboard

undera reviewed May 17, 2023

View reviewed changes

updated doc

17c2865

undera reviewed May 17, 2023

View reviewed changes

pushker001 marked this pull request as draft May 17, 2023 10:26

pushker001 marked this pull request as ready for review May 17, 2023 10:28

doc modify

6122003

undera reviewed May 17, 2023

View reviewed changes

modify doc

6bfc984

undera reviewed May 18, 2023

View reviewed changes

pushker001 commented May 18, 2023

View reviewed changes

modify doc

fcc374c

undera merged commit 0b4031b into komodorio:main May 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc Feature: Installed Releases List #356

Doc Feature: Installed Releases List #356

pushker001 commented May 17, 2023 •

edited by undera

Loading

undera May 17, 2023

undera May 17, 2023

undera commented May 17, 2023

pushker001 commented May 17, 2023

undera May 17, 2023

undera May 17, 2023

undera May 17, 2023

undera May 18, 2023

pushker001 May 18, 2023 •

edited

Loading

undera May 18, 2023

pushker001 May 18, 2023

undera May 18, 2023

codecov-commenter commented May 19, 2023

pushker001 commented May 24, 2023

undera commented May 24, 2023


		# Installed Releases list
		This tells us which chart version we are using.

		![Releases3](images/screenshot_release3.png)

		This indicates the time when your chart was last updated.


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


		This indicates the time when your release was last updated.
		![Releases4](images/screenshot_release4.png)

Doc Feature: Installed Releases List #356

Doc Feature: Installed Releases List #356

Conversation

pushker001 commented May 17, 2023 • edited by undera Loading

CheckList

Choose a reason for hiding this comment

Choose a reason for hiding this comment

undera commented May 17, 2023

pushker001 commented May 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pushker001 May 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented May 19, 2023

Codecov Report

pushker001 commented May 24, 2023

undera commented May 24, 2023

pushker001 commented May 17, 2023 •

edited by undera

Loading

pushker001 May 18, 2023 •

edited

Loading