Cleanup the spec a bit to remove WG/git text that's not really part of the spec #626

duglin · 2016-11-14T15:02:31Z

First pass - and a little bit of extra clean-up. Per the f2f at kubecon.

Signed-off-by: Doug Davis dug@us.ibm.com

wking · 2016-11-14T15:26:30Z

RELEASES.md

@@ -7,6 +7,14 @@ Releases are proposed and adopted or rejected using the usual [project governanc
 An anti-pattern that we want to avoid is heavy development or discussions "late cycle" around major releases.
 We want to build a community that is involved and communicates consistently through all releases instead of relying on "silent periods" as a judge of stability.

+## Release Process


The old project.md was runtime-spec-specific notes. This RELEASES.md is generic OCI policy. I'd rather keep those in separate files.

From an end-user perspective just trying to understand things I don't see much of a diff.

Non-maintainers have to understand neither, all maintainers have to understand the current RELEASES.md, and only @vbatts (or whoever is cutting the release) needs to understand the notes you're moving here.

i also think runtime-spec specific process doesnt need to be in the same file as the generic oci release.md. Maybe these can just be in README ? Separating makes it easier to apply upstream Release.md changes too if necessary.

ok - re-reading the RELEASES.md file.... I have no idea why that file is even here :-)
If its not runtime-spec specific then it shouldn't be in this repo at all. I'm inclined to say we remove it entirely and put it at a higher level in the OCI git repo structure, but let's do that in a separate PR. For now, there should just be one runtime-spec release process/guidance doc.

If its not runtime-spec specific then it shouldn't be in this repo at all. I'm inclined to say we remove it entirely and put it at a higher level in the OCI git repo structure, but let's do that in a separate PR.

The release-doc issue seems orthogonal to the README decoupling, so I'd rather not touch them in this PR.

And the local copy is because each project can tweak the generic docs, although they're encouraged not to.

With 082ebc1 → 60c3c76 you've restored project.md, but you still need to drop the addition here.

darn - thought I did that - fixed - thanks

wking · 2016-11-14T15:28:27Z

config-linux.md

@@ -595,7 +595,7 @@ The values MUST be absolute paths in the [container namespace][container-namespa
    "mountLabel": "system_u:object_r:svirt_sandbox_file_t:s0:c715,c811"
 ```

-[container-namespace]: glossary.md#container_namespace
+[container-namespace2]: glossary.md#container_namespace


Why this change?

The pdf generation tool was generating a warning message so this is one way to avoid that.

Probably worth putting the warning message in your commit message so that that's clear in the future.

wking · 2016-11-14T15:30:06Z

There's some overlap between this and my work-in-progress AsciiDoc translation (#615), but I'm fine rerolling my AsciiDoc if this lands first.

crosbymichael · 2016-11-14T17:31:57Z

LGTM

hqhq · 2016-11-15T07:08:39Z

Needs rebase.

duglin · 2016-11-15T15:32:40Z

rebased - I think I got the changes right.

wking · 2016-11-15T15:47:13Z

README.md

 ## Code of Conduct

 Participation in the OCI community is governed by the [OCI Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md).

+=======
+>>>>>>> 2d08a81... Cleanup the spec a bit to remove WG/git text that's not really part of the spec


Busted rebase?

duglin · 2016-11-15T16:05:51Z

@wking fixed rebase issue - thanks

wking · 2016-11-15T18:42:21Z

spec.md

+An implementation is not compliant for a given CPU architecture if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
+An implementation is compliant for a given CPU architecture if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.
+
+[rfc2119]: http://tools.ietf.org/html/rfc2119


You can drop this from the README now that you've shifted the consumer over here.

And you still need to shift over the c99-unspecified definition.

duglin · 2016-11-16T01:01:10Z

fixed extra/missing refs and backed-out the 'releases' stuff - will save for another PR.
@crosbymichael you may want to just recheck to make sure your LGTM is still true.

wking · 2016-11-16T17:43:45Z

README.md

-* Linux containers: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
-* Solaris containers: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
-* Windows containers: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
+[charter]: https://www.opencontainers.org/about/governance


This should move back into RELEASES.md.

…f the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>

dqminh · 2016-11-16T18:29:16Z

LGTM

mrunalp · 2016-11-16T18:47:43Z

LGTM

wking · 2016-11-16T18:47:51Z

e7be40f looks good to me.

Now that d43fc42 (config-linux: Lift no-tweaking namespace restriction, 2017-01-11, opencontainers#649) allows us to get into this sort of situation. This sort of ownership may also apply to other resources (cgroups?), but we can handle them in follow-up commits. Also drop "Configuration" from the root header. Everything in that file is a configuration. container-namespace3 (instead of container-namespace) supports the single-page, Pandoc-generated file (see e7be40f, Cleanup the spec a bit to remove WG/git text that's not really part of the spec, 2016-11-14, opencontainers#626). Signed-off-by: W. Trevor King <wking@tremily.us>

Now that d43fc42 (config-linux: Lift no-tweaking namespace restriction, 2017-01-11, opencontainers#649) allows us to get into this sort of situation. This sort of ownership may also apply to other resources (cgroups?), but we can handle them in follow-up commits. Also drop "Configuration" from the root header. Everything in that file is a configuration. container-namespace3 (instead of container-namespace) supports the single-page, Pandoc-generated file (see e7be40f, Cleanup the spec a bit to remove WG/git text that's not really part of the spec, 2016-11-14, opencontainers#626). Using an informative suggestion was recommended by Dao Quang Minh [1]. I've made the config JSON as small as possible while keeping it valid, but there's still an unfortunate amount of boilerplate there. There is in-flight work to let us at least drop process.args [2]. [1]: opencontainers#651 [2]: opencontainers#620 Signed-off-by: W. Trevor King <wking@tremily.us>

Now that d43fc42 (config-linux: Lift no-tweaking namespace restriction, 2017-01-11, opencontainers#649) allows us to get into this sort of situation. This sort of ownership may also apply to other resources (cgroups?), but we can handle them in follow-up commits. Using an informative suggestion was recommended by Dao Quang Minh [1]. I've made the config JSON as small as possible while keeping it valid, but there's still an unfortunate amount of boilerplate there. There is in-flight work to let us at least drop process.args [2]. The new mount namespace in the UTS example avoids pivoting the host namespace's root. Also drop "Configuration" from the root header. Everything in that file is a configuration. container-namespace3 (instead of container-namespace) supports the single-page, Pandoc-generated file (see e7be40f, Cleanup the spec a bit to remove WG/git text that's not really part of the spec, 2016-11-14, opencontainers#626). [1]: opencontainers#651 [2]: opencontainers#620 Signed-off-by: W. Trevor King <wking@tremily.us>

The capitalization in "Container Configuration file" (which we've used since 70372d3, *.md: update TOC and links, 2015-09-10, opencontainers#176) was halfway between "Title Case" and "Sentence case". The current spec isn't particularly consistent (e.g. we have both "Specification version" and "POSIX process"), but the ToC has used "Configuration" for this file since e7be40f (Cleanup the spec a bit to remove WG/git text that's not really part of the spec, 2016-11-14, opencontainers#626) so dodge the sentence/title issue and use that here too. Signed-off-by: W. Trevor King <wking@tremily.us>

The capitalization in "Container Configuration file" (which we've used since 70372d3, *.md: update TOC and links, 2015-09-10, opencontainers#176) was halfway between "Title Case" and "Sentence case". The current spec isn't particularly consistent (e.g. we have both "Specification version" and "POSIX-platform Mounts"), but the ToC has used "Configuration" for this file since e7be40f (Cleanup the spec a bit to remove WG/git text that's not really part of the spec, 2016-11-14, opencontainers#626) so dodge the sentence/title issue and use that here too. Signed-off-by: W. Trevor King <wking@tremily.us>

wking reviewed Nov 14, 2016

View reviewed changes

duglin force-pushed the specCleanup branch from 89c88c5 to 2d08a81 Compare November 14, 2016 15:51

duglin force-pushed the specCleanup branch from 2d08a81 to dbe7802 Compare November 15, 2016 15:32

wking reviewed Nov 15, 2016

View reviewed changes

duglin force-pushed the specCleanup branch from dbe7802 to 082ebc1 Compare November 15, 2016 16:05

wking reviewed Nov 15, 2016

View reviewed changes

duglin mentioned this pull request Nov 15, 2016

Transition from Markdown to AsciiDoc #628

Closed

duglin force-pushed the specCleanup branch from 082ebc1 to 60c3c76 Compare November 16, 2016 01:00

duglin force-pushed the specCleanup branch from 60c3c76 to 39af4ce Compare November 16, 2016 14:30

duglin mentioned this pull request Nov 16, 2016

Clean-up spec to remove non-spec-ish items opencontainers/image-spec#458

Merged

wking reviewed Nov 16, 2016

View reviewed changes

Cleanup the spec a bit to remove WG/git text that's not really part o…

e7be40f

…f the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>

duglin force-pushed the specCleanup branch from 39af4ce to e7be40f Compare November 16, 2016 17:50

mrunalp merged commit 7839cbb into opencontainers:master Nov 16, 2016

wking mentioned this pull request Nov 16, 2016

Replace Markdown with reStructuredText or AsciiDoc or some such? #615

Closed

wking mentioned this pull request Nov 28, 2016

Add Runtime CLI Spec #513

Closed

vbatts mentioned this pull request Dec 7, 2016

Version bump for v1.0.0-rc3 #642

Merged

wking mentioned this pull request Feb 10, 2017

make link usage consistent across the specification #687

Merged

wking mentioned this pull request Jul 19, 2017

config: Simplify title to "Configuration" #901

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cleanup the spec a bit to remove WG/git text that's not really part of the spec #626

Cleanup the spec a bit to remove WG/git text that's not really part of the spec #626

duglin commented Nov 14, 2016

wking Nov 14, 2016

duglin Nov 14, 2016

wking Nov 14, 2016

dqminh Nov 15, 2016

duglin Nov 15, 2016

wking Nov 15, 2016

wking Nov 16, 2016

duglin Nov 16, 2016

wking Nov 14, 2016

duglin Nov 14, 2016

wking Nov 14, 2016

duglin Nov 14, 2016

wking commented Nov 14, 2016

crosbymichael commented Nov 14, 2016 •

edited by caniszczyk

Loading

hqhq commented Nov 15, 2016

duglin commented Nov 15, 2016

wking Nov 15, 2016

duglin commented Nov 15, 2016

wking Nov 15, 2016

wking Nov 15, 2016

duglin commented Nov 16, 2016

wking Nov 16, 2016

duglin Nov 16, 2016

dqminh commented Nov 16, 2016 •

edited by caniszczyk

Loading

mrunalp commented Nov 16, 2016 •

edited by caniszczyk

Loading

wking commented Nov 16, 2016 via email

Cleanup the spec a bit to remove WG/git text that's not really part of the spec #626

Cleanup the spec a bit to remove WG/git text that's not really part of the spec #626

Conversation

duglin commented Nov 14, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wking commented Nov 14, 2016

crosbymichael commented Nov 14, 2016 • edited by caniszczyk Loading

hqhq commented Nov 15, 2016

duglin commented Nov 15, 2016

Choose a reason for hiding this comment

duglin commented Nov 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duglin commented Nov 16, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dqminh commented Nov 16, 2016 • edited by caniszczyk Loading

mrunalp commented Nov 16, 2016 • edited by caniszczyk Loading

wking commented Nov 16, 2016 via email

crosbymichael commented Nov 14, 2016 •

edited by caniszczyk

Loading

dqminh commented Nov 16, 2016 •

edited by caniszczyk

Loading

mrunalp commented Nov 16, 2016 •

edited by caniszczyk

Loading