layer5io / layer5io/docs

[Docs] Audit of Kubernetes component configuration properties and descriptions

Open
#920 3 comments 0 reactions 1 assignee Claimed by @PARTH-TUSSLE View on GitHub
area/docs framework/hugo help wanted language/markdown
Dominant language
JavaScript
Stars
99
Forks
223
Avg merge
1d 1h
Merged PRs (30d)
17

Description

### Problem
Currently, in the Kanvas UI, the documentation for Kubernetes component properties is inconsistent. While some complex fields (like `selector` and `strategy` in Deployments) have an info (i) button with a brief explanation, many other essential fields (like `minReadySeconds`, `replicas`, and `progressDeadlineSeconds`) do not have any descriptions. This can be a significant path-blocker for beginners.

### Proposed Solution
I am performing a systematic audit of all components in the Kubernetes tab to map out exactly which fields are missing descriptions. My goal is to create a "no-fluff" reference guide for these properties to ensure newcomers can navigate specific configurations without getting lost.

### References
- Relocated from meshery/meshery#18189 per @leecalcote's request.
- Focus: Kubernetes components (Deployment, Service, etc.)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.