Permalink
Browse files

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

…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>
1 parent 600b8b4 commit e7be40f0c3086ade34be32fa658eccf3e481a7a1 @duglin duglin committed Nov 14, 2016
Showing with 50 additions and 51 deletions.
  1. +0 −1 .gitignore
  2. +2 −10 Makefile
  3. +11 −37 README.md
  4. +3 −3 config-linux.md
  5. +34 −0 spec.md
View
@@ -1,4 +1,3 @@
output
schema/validate
-code-of-conduct.md
version.md
View
@@ -21,13 +21,8 @@ endif
# These docs are in an order that determines how they show up in the PDF/HTML docs.
DOC_FILES := \
version.md \
- README.md \
- code-of-conduct.md \
+ spec.md \
principles.md \
- style.md \
- ROADMAP.md \
- implementations.md \
- project.md \
bundle.md \
runtime.md \
runtime-linux.md \
@@ -54,9 +49,6 @@ $(OUTPUT_DIRNAME)/$(DOC_FILENAME).html: $(DOC_FILES)
$(PANDOC) -f markdown_github -t html5 -o $(PANDOC_DST)$@ $(patsubst %,$(PANDOC_SRC)%,$(DOC_FILES))
endif
-code-of-conduct.md:
- curl -o $@ https://raw.githubusercontent.com/opencontainers/tob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md
-
version.md: ./specs-go/version.go
go run ./.tool/version-doc.go > $@
@@ -105,5 +97,5 @@ endif
.PHONY: clean
clean:
rm -rf $(OUTPUT_DIRNAME) *~
- rm -f code-of-conduct.md version.md
+ rm -f version.md
View
@@ -2,38 +2,17 @@
The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
+The specification can be found [here](spec.md).
-Table of Contents
-
-- [Introduction](README.md)
- - [Code of Conduct](#code-of-conduct)
- - [Container Principles](principles.md)
- - [Style and Conventions](style.md)
- - [Roadmap](ROADMAP.md)
- - [Implementations](implementations.md)
- - [project](project.md)
-- [Filesystem Bundle](bundle.md)
-- Runtime and Lifecycle
- - [General Runtime and Lifecycle](runtime.md)
- - [Linux-specific Runtime and Lifecycle](runtime-linux.md)
-- Configuration
- - [General Configuration](config.md)
- - [Linux-specific Configuration](config-linux.md)
- - [Solaris-specific Configuration](config-solaris.md)
- - [Windows-specific Configuration](config-windows.md)
-- [Glossary](glossary.md)
-
-The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119][rfc2119].
-
-The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
-
-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.
-
-Protocols defined by this specification are:
-* 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).
+Additional documentation about how this group operates:
+
+- [Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md)
+- [Style and Conventions](style.md)
+- [Roadmap](ROADMAP.md)
+- [Implementations](implementations.md)
+- [Releases](RELEASES.md)
+- [project](project.md)
+- [charter][charter]
# Use Cases
@@ -66,10 +45,6 @@ Issues are used for bugs and actionable items and longer discussions can happen
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
-## 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).
-
## Discuss your design
The project welcomes submissions, but please let everyone know what you are working on.
@@ -165,7 +140,6 @@ Read more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git
* If there was important/useful/essential conversation or information, copy or include a reference
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
-[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
[UberConference]: https://www.uberconference.com/opencontainers
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
-[rfc2119]: http://tools.ietf.org/html/rfc2119
+[charter]: https://www.opencontainers.org/about/governance
View
@@ -562,7 +562,7 @@ Its value is either slave, private, or shared.
## Masked Paths
**`maskedPaths`** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read.
-The values MUST be absolute paths in the [container namespace][container-namespace].
+The values MUST be absolute paths in the [container namespace][container-namespace2].
###### Example
@@ -575,7 +575,7 @@ The values MUST be absolute paths in the [container namespace][container-namespa
## Readonly Paths
**`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container.
-The values MUST be absolute paths in the [container namespace][container-namespace].
+The values MUST be absolute paths in the [container namespace][container-namespace2].
###### Example
@@ -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
[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
[cgroup-v1-cpusets]: https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt
View
@@ -0,0 +1,34 @@
+# Open Container Initiative Runtime Specification
+
+The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
+
+Protocols defined by this specification are:
+* 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).
+
+# Table of Contents
+
+- [Introduction](spec.md)
+ - [Notational Conventions](#notational-conventions)
+ - [Container Principles](principles.md)
+- [Filesystem Bundle](bundle.md)
+- [Runtime and Lifecycle](runtime.md)
+ - [Linux-specific Runtime and Lifecycle](runtime-linux.md)
+- [Configuration](config.md)
+ - [Linux-specific Configuration](config-linux.md)
+ - [Solaris-specific Configuration](config-solaris.md)
+ - [Windows-specific Configuration](config-windows.md)
+- [Glossary](glossary.md)
+
+# Notational Conventions
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119][rfc2119].
+
+The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
+
+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.
+
+[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
+[rfc2119]: http://tools.ietf.org/html/rfc2119

0 comments on commit e7be40f

Please sign in to comment.