-
Notifications
You must be signed in to change notification settings - Fork 32
Capitalization of Key Words CAMARA API guides #447
Copy link
Copy link
Closed
Labels
Fall25documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Problem description
In proposed CAMARA API Design Guide we have:
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
There is update of RFC2119 in RFC8174 stating:
Authors who follow these guidelines should incorporate this phrase
near the beginning of their document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as
described in [BCP 14](https://datatracker.ietf.org/doc/html/bcp14) [[RFC2119](https://datatracker.ietf.org/doc/html/rfc2119)] [[RFC8174](https://datatracker.ietf.org/doc/html/rfc8174)] when, and only when, they
appear in all capitals, as shown here.
Expected action
Decide if RFC8174 should be followed in guidelines documents with introductory text and capitalization of keywords.
Additional context
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Fall25documentationImprovements or additions to documentationImprovements or additions to documentation