Skip to content

Doc feature: Release Detail - #364

Merged
undera merged 1 commit into
komodorio:mainfrom
pushker001:doc
Jun 10, 2023
Merged

undera merged 1 commit into
komodorio:mainfrom
pushker001:doc

Conversation

@pushker001

@pushker001 pushker001 commented Jun 2, 2023 •

Copy link
Copy Markdown
Contributor

Help users to know the capability of Helm-Dashboard

Help user to know the capability of Helm-Dashboard
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Patch and project coverage have no change.

Comparison is base (56932f2) 29.82% compared to head (5957992) 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     #364   +/-   ##
=======================================
  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.

@undera

undera commented Jun 3, 2023

Copy link
Copy Markdown
Collaborator

Note how I edited the description of PR. It does not close issue #255, but it relates to it. This way, we'll have all the PRs linked to the same issue, and the issue is still open.

Comment thread FEATURES.md
![Releases5](images/screenshot_release5.png) No newline at end of file
![Releases5](images/screenshot_release5.png)

# Release details

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.

It's good for the start.

I would mention the block on the left is called "Revision History". It displays the list of past release revisions, with the current revision on top. And each item in it shows status, age and version upgrade/downgrade.

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.

Also, the screenshot of screenshot_release_detail1.png has much better revision history illustration.

Comment thread FEATURES.md
This indicates the status of the deployed release, and 'Age' represents the amount of time that has passed since the creation of the revision until now.
![Detail](images/screenshot_release_detail.png)

You can use the Upgrade/Downgrade button to switch to different release versions, as shown in the figure.

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.

This specific button is tricky, it changes depending on various situations. Current description is good for the start, but there should be several more variants described, as well as other buttons. This whole button block deserves description as "Action Buttons" subsection.

@undera

undera commented Jun 3, 2023

Copy link
Copy Markdown
Collaborator

Please see my comments. I can accept PR as it is now, with future improvements. If you prefer improving current PR - let me know.

@pushker001

pushker001 commented Jun 4, 2023 •

Copy link
Copy Markdown
Contributor Author

you prefer improving current PR - let me know

@undera yes I prefer future improvement

@undera
undera merged commit fc38534 into komodorio:main Jun 10, 2023
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

⌂ 换网址