Skip to content

Commit

Permalink
docs: resolves markdown error and misspells in "pushing and pulling a…
Browse files Browse the repository at this point in the history
…rtifacts" section (#230)

* resolves md error and misspells

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* id removed from link [OCI artifacts]

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* correcting mistake of previous commit

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* changing text as told by maintainers

Co-authored-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* accepting changes from @Feynman

Co-authored-by: Feynman Zhou <feynman@kubesphere.io>
Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* accepting changes from @sajayantony

Co-authored-by: Sajay Antony <sajaya@microsoft.com>
Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* adding change coming from @asmitbm

Co-authored-by: Asmit Malakannawar <81866614+asmitbm@users.noreply.github.com>
Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

* another change coming from @asmitbm

Co-authored-by: Asmit Malakannawar <81866614+asmitbm@users.noreply.github.com>
Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

---------

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>
Co-authored-by: Terry Howe <terrylhowe@gmail.com>
Co-authored-by: Feynman Zhou <feynman@kubesphere.io>
Co-authored-by: Sajay Antony <sajaya@microsoft.com>
Co-authored-by: Asmit Malakannawar <81866614+asmitbm@users.noreply.github.com>
  • Loading branch information
5 people authored Jul 27, 2023
1 parent a156fb0 commit 5f832aa
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/how_to_guides/pushing_and_pulling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ All users can access container images stored in centralized repositories called

# Pushing

## Pushing artifacts with single files
## Pushing artifacts with single file

Pushing single files involves referencing the unique artifact type and at least one file.
Pushing a single file artifact involves referencing the unique artifact type and a file.
Defining an Artifact uses the `config.mediaType` as the unique artifact type. If a config object is provided, the `mediaType` extension defines the config filetype. If a `null` config is passed, the config extension must be removed.

See: [Defining a Unique Artifact Type](https://github.com/opencontainers/artifacts/blob/main/artifact-authors.md#defining-a-unique-artifact-type)
Expand Down Expand Up @@ -72,7 +72,7 @@ In this example, we'll push a collection of files.
- A single file (`artifact.txt`) that represents overview content that might be displayed as a repository overview
- A collection of files (`docs/*`) that represents detailed content. When specifying a directory, ORAS will automatically tar the contents.

See [OCI Artifacts][artifacts] for more details.
See [OCI Artifacts](https://github.com/opencontainers/image-spec/blob/main/manifest.md#guidelines-for-artifact-usage) for more details.

- Create additional blobs

Expand Down Expand Up @@ -140,8 +140,8 @@ oras pull localhost:5000/hello-artifact:v2
## Using cache when pulling artifacts
In order to save unnecessary network bandwidth and disk I/O oras should provides a solution to pull the artifacts into a local content-address storage (CAS) if the content does not exist, and then copy the artifact to the desired storage.
ORAS pulls the artifact into a content-addressable storage (CAS) cache if the content is not available locally to save bandwidth and disk I/O.
Once the content is availabe in the cache, ORAS copies the artifact to the desired location.
The cache directory is specified by using the environment variable `ORAS_CACHE`. If not specified, cache is not used.
```
Expand All @@ -152,4 +152,4 @@ export ORAS_CACHE=~/.oras/cache
```
# Pull artifacts as usual
oras pull localhost:5000/hello:latest
```
```

0 comments on commit 5f832aa

Please sign in to comment.