You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need to document current capabilities of application, with good screenshots, to let new and old users know of all features. No need to write too much of text, we rather need discovery walkthrough.
Probably, it should be a separate Markdown page, or even multiple pages one per area.
Below is the checklist of all the capabilities, without particular sorting.
General layout
Shutting down the app
REST API docs
Reset cache Multi-cluster
Installed releases list
Filter by namespaces and free text List of releases - with release status+installed resources status. Basic info on release: chart, version, icon etc.
Indication of upgrade possible/repo suggested.
Release details
Revision history - status, age, upgrade or downgrade, rollback icon
Uninstalling
Running test hooks
Update repo / add missing repo
Upgrade / Reconfiguring / Even without source chart
Rollback
Release revision details
Basic info - revision, date, message, cluster, status
Resources tab - kind, name, status, msg, describe, scan
Manifests tab - text, diff with previous, diff with specific
Values tab - text, diff, + user-defined flag
Notes - text, diff
Install/Upgrade/Reconfigure dialog
Version selector - with originating repo info, current version displayed and marked
Release name, namespace, cluster
Values editor
Values reference doc
Changes diff preview
Problem scanning btn
Repo list
[local] pseudo-repo
note on autoupdate repo
updating repo add new repo delete repo triggering install
To build this document, you need to learn to use Helm Dashboard, have a demo cluster where you'll install and modify charts. You can build the document gradually, bringing PR as small as single item from the list above.
Reacted by Susmita Dey, Pushkar Pandey and Rohan Mishra
Hey @undera I'd like to contribute to the REST API docs. Are you expecting a swagger documentation or a markdown file that serves as a documentation for the REST APIs?
Hey @undera I'd like to contribute to the REST API docs. Are you expecting a swagger documentation or a markdown file that serves as a documentation for the REST APIs?
What is meant by "REST API docs" is to explain in markdown doc what's the purpose of "Help -> REST API" button. It's quite trivial purpose of displaying OpenAPI docs page where user can learn how to interact with Helm Dashboard programmatically.
Activity
Praashh commentedon Mar 31, 2023
Hey Can you assign this issue to me?
Susmita-Dey commentedon Apr 8, 2023
Hello @undera I can do it but I need a little guidance on it
undera commentedon Apr 8, 2023
People, don't ask to assign, just bring the PR with changes.
The features overview doc is meant to be something like this: https://github.com/wptrainingteam/dashboard-overview or https://github.com/markteekman/accessible-astro-dashboard, with screenshots instead of code blocks.
To build this document, you need to learn to use Helm Dashboard, have a demo cluster where you'll install and modify charts. You can build the document gradually, bringing PR as small as single item from the list above.
pushker001 commentedon Apr 13, 2023
@undera Where to upload the doc content should I create a new file like
readme.mdbefore the PR?undera commentedon Apr 13, 2023
Create a new
Features.mdfile and start thereFEATURES.md file #255 (#425)
vr1Ravi commentedon Oct 14, 2023
why this is still open
undera commentedon Oct 15, 2023
Because not all the capabilities are documented @vr1Ravi. You can see in the issue description what is documented and what is not.
nithin-sudarsan commentedon Feb 21, 2024
Hey @undera I'd like to contribute to the REST API docs. Are you expecting a swagger documentation or a markdown file that serves as a documentation for the REST APIs?
undera commentedon Feb 21, 2024
We already have functional OpenAPI spec here: https://github.com/komodorio/helm-dashboard/blob/main/frontend/public/openapi.json
I don't want to duplicate information from it into markdown.
What is meant by "REST API docs" is to explain in markdown doc what's the purpose of "Help -> REST API" button. It's quite trivial purpose of displaying OpenAPI docs page where user can learn how to interact with Helm Dashboard programmatically.