You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ The [Open Container Initiative](http://www.opencontainers.org/) develops specifi
4
4
5
5
The specification can be found [here](spec.md).
6
6
7
+
## Table of Contents
8
+
7
9
Additional documentation about how this group operates:
8
10
9
11
-[Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md)
@@ -14,38 +16,38 @@ Additional documentation about how this group operates:
14
16
-[project](project.md)
15
17
-[charter][charter]
16
18
17
-
# Use Cases
19
+
##Use Cases
18
20
19
21
To provide context for users the following section gives example use cases for each part of the spec.
20
22
21
-
####Application Bundle Builders
23
+
### Application Bundle Builders
22
24
23
25
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
24
26
The bundle contains an OCI [configuration file](config.md) where the builder can specify host-independent details such as [which executable to launch](config.md#process) and host-specific settings such as [mount](config.md#mounts) locations, [hook](config.md#hooks) paths, Linux [namespaces](config-linux.md#namespaces) and [cgroups](config-linux.md#control-groups).
25
27
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
26
28
27
-
####Hook Developers
29
+
### Hook Developers
28
30
29
31
[Hook](config.md#hooks) developers can extend the functionality of an OCI-compliant runtime by hooking into a container's lifecycle with an external application.
30
32
Example use cases include sophisticated network configuration, volume garbage collection, etc.
31
33
32
-
####Runtime Developers
34
+
### Runtime Developers
33
35
34
36
Runtime developers can build runtime implementations that run OCI-compliant bundles and container configuration, containing low-level OS and host specific details, on a particular platform.
35
37
36
-
# Releases
38
+
##Releases
37
39
38
40
There is a loose [Road Map](./ROADMAP.md).
39
41
During the `0.x` series of OCI releases we make no backwards compatibility guarantees and intend to break the schema during this series.
40
42
41
-
# Contributing
43
+
##Contributing
42
44
43
45
Development happens on GitHub for the spec.
44
46
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
45
47
46
48
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
47
49
48
-
## Discuss your design
50
+
###Discuss your design
49
51
50
52
The project welcomes submissions, but please let everyone know what you are working on.
51
53
@@ -56,24 +58,24 @@ It also guarantees that the design is sound before code is written; a GitHub pul
56
58
Typos and grammatical errors can go straight to a pull-request.
57
59
When in doubt, start on the [mailing-list](#mailing-list).
58
60
59
-
## Weekly Call
61
+
###Weekly Call
60
62
61
63
The contributors and maintainers of all OCI projects have a weekly meeting Wednesdays at 2:00 PM (USA Pacific).
62
64
Everyone is welcome to participate via [UberConference web][UberConference] or audio-only: 415-968-0849 (no PIN needed.)
63
65
An initial agenda will be posted to the [mailing list](#mailing-list) earlier in the week, and everyone is welcome to propose additional topics or suggest other agenda alterations there.
64
66
Minutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived to the [wiki](https://github.com/opencontainers/runtime-spec/wiki) for those who are unable to join the call.
65
67
66
-
## Mailing List
68
+
###Mailing List
67
69
68
70
You can subscribe and join the mailing list on [Google Groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).
69
71
70
-
## IRC
72
+
###IRC
71
73
72
74
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
73
75
74
-
## Git commit
76
+
###Git commit
75
77
76
-
### Sign your work
78
+
####Sign your work
77
79
78
80
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.
79
81
The rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):
@@ -125,7 +127,7 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
125
127
126
128
You can add the sign off when creating the git commit via `git commit -s`.
127
129
128
-
### Commit Style
130
+
####Commit Style
129
131
130
132
Simple house-keeping for clean git history.
131
133
Read more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) or the Discussion section of [`git-commit(1)`](http://git-scm.com/docs/git-commit).
0 commit comments