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.

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 Feature: Installed Releases List #356

Merged
merged 5 commits into from
May 24, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,17 @@ Use the filter option to find the desired chart quicker from the list of charts.
![Repository6](images/screenshot_repository6.png)

If you want to install a particular chart, simply hover the pointer over the chart name and an 'Install' button will appear, as shown in the figure.
![Repository7](images/screenshot_repository7.png)
![Repository7](images/screenshot_repository7.png)

# Installed Releases list
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

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

A revision is linked to a release to track the number of updates/changes that release encounters.
![Releases2](images/screenshot_release2.png)

Namespaces are a way to organize clusters into virtual sub-clusters — they can be helpful when different teams or projects share a Kubernetes cluster. Any number of namespaces are supported within a cluster, each logically separated from others but with the ability to communicate with each other.
![Releases3](images/screenshot_release3.png)

This indicates the time when your release was last updated.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

![Releases4](images/screenshot_release4.png)
Binary file added images/screenshot_release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot_release2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot_release3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot_release4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot_release5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading