Skip to content

[Tracking Issue] Developer Guide Audit #5229

Open
@mrbobbytables

Description

@mrbobbytables

Problem
Documentation is the go-to reference for contributors. Parts of the developer guide have been cited as vastly out of date (e.g. referencing VERY outdated versions of docker). This puts up significant road blocks for contributors, either getting started or looking for best practices on how they should approach a problem.

Goal
Audit the developer guide and note the sections that are out of date or are missing. The notes from the audit will be used to create targeted issues for updating the associated sections of the guide.

SIG Devel Guide Link Issue
API Machinery link #5230
Architecture link #5231
CLI link #5232
Instrumentation link #5233
Node link #5234
Release link #5235
Scalability link #5236
Scheduling link #5237
Storage link #5238
Testing link #5239

/sig contributor-experience
/area developer-guide
/milestone v1.20

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/developer-guideIssues or PRs related to the developer guidekind/documentationCategorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.sig/contributor-experienceCategorizes an issue or PR as relevant to SIG Contributor Experience.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions