Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: resolves markdown error and misspells in "pushing and pulling artifacts" section #230

Merged
merged 9 commits into from
Jul 27, 2023
Merged

docs: resolves markdown error and misspells in "pushing and pulling artifacts" section #230

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
934193e
resolves md error and misspells
1Shubham7 Jul 20, 2023
02e9a27
id removed from link [OCI artifacts]
1Shubham7 Jul 20, 2023
268b606
correcting mistake of previous commit
1Shubham7 Jul 20, 2023
69c2715
changing text as told by maintainers
1Shubham7 Jul 20, 2023
0a50d7a
accepting changes from @feynman
1Shubham7 Jul 24, 2023
bf17a9a
accepting changes from @sajayantony
1Shubham7 Jul 24, 2023
157ee44
Merge branch 'oras-project:main' into main
1Shubham7 Jul 25, 2023
0e10aa6
adding change coming from @asmitbm
1Shubham7 Jul 27, 2023
5dfa28f
another change coming from @asmitbm
1Shubham7 Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/how_to_guides/pushing_and_pulling.mdx
View file
Open in desktop
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/artifacts/blob/main/artifact-authors.md#defining-a-unique-artifact-type) for more details.
1Shubham7 marked this conversation as resolved.
Show resolved Hide resolved

- Create additional blobs

Expand Down Expand Up @@ -140,7 +140,7 @@ 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.
In order to save unnecessary network bandwidth and disk I/O, oras 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.

1Shubham7 marked this conversation as resolved.
Show resolved Hide resolved
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
```
```