Skip to content

Commit c368be6

Browse files
author
Mrunal Patel
authored
Merge pull request #650 from wking/readme-header-nesting
README: Consistent header nesting
2 parents dc0fa75 + 200e86f commit c368be6

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ The [Open Container Initiative](http://www.opencontainers.org/) develops specifi
44

55
The specification can be found [here](spec.md).
66

7+
## Table of Contents
8+
79
Additional documentation about how this group operates:
810

911
- [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:
1416
- [project](project.md)
1517
- [charter][charter]
1618

17-
# Use Cases
19+
## Use Cases
1820

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

21-
#### Application Bundle Builders
23+
### Application Bundle Builders
2224

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

27-
#### Hook Developers
29+
### Hook Developers
2830

2931
[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.
3032
Example use cases include sophisticated network configuration, volume garbage collection, etc.
3133

32-
#### Runtime Developers
34+
### Runtime Developers
3335

3436
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.
3537

36-
# Releases
38+
## Releases
3739

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

41-
# Contributing
43+
## Contributing
4244

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

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

48-
## Discuss your design
50+
### Discuss your design
4951

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

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

59-
## Weekly Call
61+
### Weekly Call
6062

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

66-
## Mailing List
68+
### Mailing List
6769

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

70-
## IRC
72+
### IRC
7173

7274
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
7375

74-
## Git commit
76+
### Git commit
7577

76-
### Sign your work
78+
#### Sign your work
7779

7880
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.
7981
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.)
125127

126128
You can add the sign off when creating the git commit via `git commit -s`.
127129

128-
### Commit Style
130+
#### Commit Style
129131

130132
Simple house-keeping for clean git history.
131133
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)