Documentation of components and API - Githubissues

headlamp-k8s / headlamp

A Kubernetes web UI that is fully-featured, user-friendly and extensible

https://headlamp.dev

Apache License 2.0

2.22k stars 156 forks source link

Documentation of components and API #205

Closed illume closed 3 years ago

illume commented 3 years ago

Current situation

For headlamp developers and plugin authors it would be useful to have more documentation of certain APIs and components.

Impact

Improves the developer experience.

Ideal future situation

Locally inside an IDE (like vscode) documentation for relevant APIs is shown.
Locally the storybook tool can be used to discover and develop components.
Published online in the Kinvolk docs, people can view components and API docs.

Implementation options

Typedoc and Storybook can provide this.

The components (at least common) all have stories, and at least lib/k8s API is mostly documented.

joaquimrocha commented 3 years ago

The bulk of it is done, even if we're not covering everything 100%. Closing.