Skip to content

Commit 60d2987

Browse files
committed
README: Consistent header nesting
And add headers for the Table of Contents and Compliance sections. Signed-off-by: W. Trevor King <[email protected]>
1 parent b3ce195 commit 60d2987

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
44

5-
6-
Table of Contents
5+
## Table of Contents
76

87
- [Introduction](README.md)
98
- [Code of Conduct](#code-of-conduct)
@@ -22,6 +21,8 @@ Table of Contents
2221
- [Solaris-specific Configuration](config-solaris.md)
2322
- [Glossary](glossary.md)
2423

24+
## Compliance
25+
2526
In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
2627

2728
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.
@@ -31,42 +32,42 @@ Protocols defined by this specification are:
3132
* Linux containers: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
3233
* Solaris containers: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
3334

34-
# Use Cases
35+
## Use Cases
3536

3637
To provide context for users the following section gives example use cases for each part of the spec.
3738

38-
#### Application Bundle Builders
39+
### Application Bundle Builders
3940

4041
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
4142
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-configuration) 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).
4243
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
4344

44-
#### Hook Developers
45+
### Hook Developers
4546

4647
[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.
4748
Example use cases include sophisticated network configuration, volume garbage collection, etc.
4849

49-
#### Runtime Developers
50+
### Runtime Developers
5051

5152
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.
5253

53-
# Releases
54+
## Releases
5455

5556
There is a loose [Road Map](./ROADMAP.md).
5657
During the `0.x` series of OCI releases we make no backwards compatibility guarantees and intend to break the schema during this series.
5758

58-
# Contributing
59+
## Contributing
5960

6061
Development happens on GitHub for the spec.
6162
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
6263

6364
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
6465

65-
## Code of Conduct
66+
### Code of Conduct
6667

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

69-
## Discuss your design
70+
### Discuss your design
7071

7172
The project welcomes submissions, but please let everyone know what you are working on.
7273

@@ -77,24 +78,24 @@ It also guarantees that the design is sound before code is written; a GitHub pul
7778
Typos and grammatical errors can go straight to a pull-request.
7879
When in doubt, start on the [mailing-list](#mailing-list).
7980

80-
## Weekly Call
81+
### Weekly Call
8182

8283
The contributors and maintainers of all OCI projects have a weekly meeting Wednesdays at 2:00 PM (USA Pacific).
8384
Everyone is welcome to participate via [UberConference web][UberConference] or audio-only: 415-968-0849 (no PIN needed.)
8485
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.
8586
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.
8687

87-
## Mailing List
88+
### Mailing List
8889

8990
You can subscribe and join the mailing list on [Google Groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).
9091

91-
## IRC
92+
### IRC
9293

9394
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
9495

95-
## Git commit
96+
### Git commit
9697

97-
### Sign your work
98+
#### Sign your work
9899

99100
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.
100101
The rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):
@@ -146,7 +147,7 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
146147

147148
You can add the sign off when creating the git commit via `git commit -s`.
148149

149-
### Commit Style
150+
#### Commit Style
150151

151152
Simple house-keeping for clean git history.
152153
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

Comments
 (0)