Skip to content

Section Separation and Ordering for Engine API #22583

Open
@RoughlyHewn

Description

@RoughlyHewn

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

The endpoint section is not separated from the non-endpoint information. There is no clear ordering for the endpoints.

Location

https://docs.docker.com/reference/api/engine/version/v1.49/

Suggestion

Create a "Getting Started" or "Overview" heading to contain the Errors, Versioning, and Authentication sections. Below that, create an "Endpoint" heading and consider ordering the endpoints in alphabetical order.

Metadata

Metadata

Labels

area/apiRelates to Docker API docswtd-projectRelates to WTD API docs project

Type

No type

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions