helm-dashboard
helm-dashboard copied to clipboard
komodorio
Document application capabilities
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~~
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.
@undera Where to upload the doc content should I create a new file like readme.md before the PR?
why this is still open
Because not all the capabilities are documented @vr1Ravi. You can see in the issue description what is documented and what is not.
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?
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.