kubernetes / kubernetes/website

API style/conventions guide

Open
#26,190 12 comments 2 reactions 1 assignee Claimed by @shannonxtreme View on GitHub
kind/feature language/en lifecycle/frozen needs-triage priority/important-longterm wg/api-expression
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Feature Request**

It may be worthwhile to create a style/conventions guide for the Kubernetes API to:
- explain the design of the API and how to use the API
- describe how to refer to resources and type definitions
- describe how to format HTTP verbs, requests/responses
- describe any shortcodes used to create API-related content
- describe or clarify how contributors can create or edit type definition content in k8s/k8s
- describe the common includes to display on an API resource page/type (title, version information, group, kind, import statement(?), add "generated by:" publishing string).

The SIG Docs style guide includes limited guidance on capitalizing and formatting API resource names in the content.
The site reference section also includes one or two pages describing the API conventions and descriptions for
interacting with the API. In addition, there are design documents found in other repositories related to the project.

**What would you like to be added**
Create new pages (update current pages) to describe the style and conventions of the API.

**Why is this needed**
Several pull requests and issues have been raised about capitalization and naming of the API resources.
The tools generating the reference documentation have changed. The output generated by the different tools use different styles, formatting, and conventions. A style/conventions guide would help define a consistent style and language for describing the
API concepts.

**Comments**
https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects
https://kubernetes.io/docs/reference/using-api/api-concepts/

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.