Skip to content

Commit c942816

Browse files
committed
Add anchors to misc. docs
Signed-off-by: Mrunal Patel <[email protected]>
1 parent 4b07554 commit c942816

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

implementations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Implementations
1+
# <a name="implementations" />Implementations
22

33
The following sections link to associated projects, some of which are maintained by the OCI and some of which are maintained by external organizations.
44
If you know of any associated projects that are not listed here, please file a pull request adding a link to that project.
55

6-
## Runtime (Container)
6+
## <a name"implementationsRuntimeContainer" />Runtime (Container)
77

88
* [opencontainers/runc](https://github.com/opencontainers/runc) - Reference implementation of OCI runtime
99

10-
## Runtime (Virtual Machine)
10+
## <a name="implementationsRuntimeVirtualMachine" />Runtime (Virtual Machine)
1111

1212
* [hyperhq/runv](https://github.com/hyperhq/runv) - Hypervisor-based runtime for OCI
1313
* [01org/cc-oci-runtime](https://github.com/01org/cc-oci-runtime) - Hypervisor-based OCI runtime for Intel® Architecture
1414

15-
## Testing & Tools
15+
## <a name="implementationsTestingTools" />Testing & Tools
1616

1717
* [kunalkushwaha/octool](https://github.com/kunalkushwaha/octool) - A config linter and validator.
1818
* [huawei-openlab/oct](https://github.com/huawei-openlab/oct) - Open Container Testing framework for OCI configuration and runtime

project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Project docs
1+
# <a name="projectDocs" />Project docs
22

3-
## Release Process
3+
## <a name="projectReleaseProcess" />Release Process
44

55
* Increment version in [`specs-go/version.go`](specs-go/version.go)
66
* `git commit` version increment

spec.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# Open Container Initiative Runtime Specification
1+
# <a name="openContainerInitiativeRuntimeSpecification" />Open Container Initiative Runtime Specification
22

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

5-
# Abstract
5+
# <a name="ociRuntimeSpecAbstract" />Abstract
66

77
The OCI Runtime Specification aims to specify the configuration, execution environment, and lifecycle a container.
88

99
A container's configuration is specified as the `config.json` for the supported platforms and details the fields that enable the creation of a container.
1010
The execution environment is specified to ensure that applications running inside a container have a consistent environment between runtimes along with common actions defined for the container's lifecycle.
1111

12-
# Platforms
12+
# <a name="ociRuntimeSpecPlatforms" />Platforms
1313

1414
Platforms defined by this specification are:
1515

1616
* `linux`: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
1717
* `solaris`: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
1818
* `windows`: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
1919

20-
# Table of Contents
20+
# <a name="ociRuntimeSpecTOC" />Table of Contents
2121

2222
- [Introduction](spec.md)
2323
- [Notational Conventions](#notational-conventions)
@@ -31,7 +31,7 @@ Platforms defined by this specification are:
3131
- [Windows-specific Configuration](config-windows.md)
3232
- [Glossary](glossary.md)
3333

34-
# Notational Conventions
34+
# <a name="ociRuntimeSpecNotationalConventions" />Notational Conventions
3535

3636
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].
3737

style.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# Style and conventions
1+
# <a name="styleAndConventions" />Style and conventions
22

3-
## One sentence per line
3+
## <a name="styleOneSentence" />One sentence per line
44

55
To keep consistency throughout the Markdown files in the Open Container spec all files should be formatted one sentence per line.
66
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
77
For example, this paragraph will span three lines in the Markdown source.
88

9-
## Traditionally hex settings should use JSON integers, not JSON strings
9+
## <a name="styleHex" />Traditionally hex settings should use JSON integers, not JSON strings
1010

1111
For example, [`"classID": 1048577`][class-id] instead of `"classID": "0x100001"`.
1212
The config JSON isn't enough of a UI to be worth jumping through string <-> integer hoops to support an 0x… form ([source][integer-over-hex]).
1313

14-
## Constant names should keep redundant prefixes
14+
## <a name="styleConstantNames" />Constant names should keep redundant prefixes
1515

1616
For example, `CAP_KILL` instead of `KILL` in [**`linux.capabilities`**][capabilities].
1717
The redundancy reduction from removing the namespacing prefix is not useful enough to be worth trimming the upstream identifier ([source][keep-prefix]).
1818

19-
## Optional settings should not have pointer Go types
19+
## <a name="styleOptionalSettings" />Optional settings should not have pointer Go types
2020

2121
Because in many cases the Go default for the type is a no-op in the spec (sources [here][no-pointer-for-strings], [here][no-pointer-for-slices], and [here][no-pointer-for-boolean]).
2222
The exceptions are entries where we need to distinguish between “not set” and “set to the Go default for that type” ([source][pointer-when-updates-require-changes]), and this decision should be made on a per-setting case.
2323

2424
## Examples
2525

26-
### Anchoring
26+
### <a name="styleAnchoring" />Anchoring
2727

2828
For any given section that provides a notable example, it is ideal to have it denoted with [markdown headers][markdown-headers].
2929
The level of header should be such that it is a subheader of the header it is an example of.
@@ -47,7 +47,7 @@ To use Some Topic, ...
4747

4848
```
4949

50-
### Content
50+
### <a name="styleContent" />Content
5151

5252
Where necessary, the values in the example can be empty or unset, but accommodate with comments regarding this intention.
5353

0 commit comments

Comments
 (0)