adds text describing the upper-case keywords used in the spec #260
Conversation
keyword-guidelines.md
Outdated
There was a problem hiding this comment.
I think adding the reference (and link) to RFC2119 is good enough. I don't think we should repeat it here, so I'd remove the text below. Repeating it means that if, heaven forbid, there's a typo in there we'd have to explain which one wins and that's just annoying. Avoid the entire issue by just having a reference.
There was a problem hiding this comment.
Which means we probably don't need an entire file for it, just add it to the top of each stand-alone doc.
mikebrow
force-pushed
the
RFC2119
branch
2 times, most recently
from
1ba8b71 to
c32dc93
Compare
|
Updated to address @duglin 's comments. |
|
On Tue, Dec 01, 2015 at 01:57:53PM -0800, Mike Brown wrote:
This is all pre-1.0, so I don't see a need for a flag day. c32dc93 |
README.md
Outdated
There was a problem hiding this comment.
I prefer the HTML RFC renderings (e.g. RFC 2199), because they have anchors for linking, links to errata, obsoleting RFCs, etc. They also have a link to the text and PDF renderings, so folks who would rather not view the HTML are a click away from their preferred format.
This is likely where opencontainers/specs is going [1], although the PR hasn't landed yet [2]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260
|
Changed the link to point to the root html page that links to the other renderings, errata, etc. |
|
On Thu, Dec 03, 2015 at 12:34:17PM -0800, Mike Brown wrote:
8cc7832 looks good to me. |
|
@mikebrow In specs, all files should be formatted one sentence per line, see https://github.com/opencontainers/specs/blob/master/README.md#markdown-style Otherwise, LGTM. Thanks. |
Signed-off-by: Mike Brown <[email protected]>
|
Changed to one line per spec md style requirement. |
|
On Fri, Dec 04, 2015 at 07:35:01AM -0800, Mike Brown wrote:
Ah, I'd forgotten to check for that one ;). 57a196a still looks good |
|
LGTM |
|
LGTM |
adds text describing the upper-case keywords used in the spec
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]> Reviewed-by: Mike Brown <[email protected]>
6 participants
It may not be flag day yet... but here's the PR to address issue #256
Signed-off-by: Mike Brown [email protected]