kubernetes-sigs / kubernetes-sigs/reference-docs

Improve API reference for non-resource paths

Open
#96 10 comments 1 reaction 0 assignees View on GitHub
lifecycle/frozen
Dominant language
HTML
Stars
130
Forks
135
Avg merge
16h 27m
Merged PRs (30d)
3

Description

The current doc generator is centered around resources and operations on them. There are quite a few other non-resource paths which can/should be processed. Need to:

- figure out a way to present them;
- remove them from the blacked list.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by locating the doc generator and its current resource/operation handling and blacklist, then determine how non-resource paths should be presented and verify that they are no longer excluded.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.