Skip to content
This repository was archived by the owner on Jul 18, 2023. It is now read-only.

Commit 6e75f75

Browse files
authored
Merge pull request #21 from mikebrow/update-readme-point-to-artifact-guidance
linking the rdme to the artifact authors guide-reference document
2 parents 71c3fc4 + 659093e commit 6e75f75

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# OCI Artifacts
22

3+
## Artifact Guidance Documents
4+
5+
1. [Arifact Author Guidance](./artifact-authors.md)
6+
7+
## Supporting Documents
8+
9+
- [Term Definitions](./definitions-terms.md)
10+
11+
## Project Introduction and Scope
12+
313
Container registries, implementing the [distribution-spec][distribution-spec], provide reliable, highly scalable, secured storage services for container images. Customers either use a cloud provider implementation, vendor implementations, or instance the open source implementation of [distribution][distribution]. They configure security and networking to assure the images in the registry are locked down and accessible by the resources required. Cloud providers and vendors often provide additional values atop their registry implementations from security to productivity features.
414

515
Applications and services typically require additional artifacts to deploy and manage, including [helm](https://helm.sh) for deployment and [Open Policy Agent (OPA)](https://github.com/open-policy-agent/opa/issues/1413) for policy enforcement.
@@ -15,7 +25,7 @@ More particularly this repository has been tasked by the [OCI TOB](https://githu
1525

1626
By providing an OCI artifact definition, the community can continue to innovate, focusing on new artifact types without having to build yet another storage solution (YASS).
1727

18-
## Table of Contents
28+
## Project Governance and License
1929

2030
- [Artifact Authors- How To][artifact-authors]
2131
- [The Apache License, Version 2.0](LICENSE)

artifact-authors.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Open Container Initiative
1+
# Open Containers Initiative
2+
3+
## Artifact Authors Guidance
4+
This reference provides guidance for authoring new artifact types.
25

36
## OCI Artifacts Support
47

0 commit comments

Comments
 (0)