Skip to content

Document application capabilities #255

Open
@undera

Description

@undera

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions