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.

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

docs: add guide for uploading packs to oci registries #2541

Merged
merged 15 commits into from
Apr 15, 2024
Merged

Conversation

caroldelwing
Copy link
Contributor

@caroldelwing caroldelwing commented Apr 1, 2024

Describe the Change

This PR adds the following pages:

  • An intro page called Add a Pack to an OCI Registry.
  • A how-to guide that explains how to upload packs to a Basic OCI registry.
  • A how-to guide that explains how to upload packs to an ECR registry.

Additionally, this PR adds ORAS to Vale and the tar command to the exceptions list of the commands' long-form Vale rule.

Changed Pages

💻 Add a Pack to an OCI Registry
💻 Add a Pack to a Basic OCI Registry
💻 Add a Pack to an ECR Registry

Jira Tickets

🎫 DOC-1038

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

@caroldelwing caroldelwing added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 labels Apr 1, 2024
Copy link

netlify bot commented Apr 1, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 662fe31
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/660aee918510dd0008c3c27a
😎 Deploy Preview https://deploy-preview-2541--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Apr 1, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 631e0db
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/661d85c1b734970007bdc92f
😎 Deploy Preview https://deploy-preview-2541--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@caroldelwing caroldelwing marked this pull request as ready for review April 1, 2024 17:53
@caroldelwing caroldelwing requested a review from a team as a code owner April 1, 2024 17:53
Copy link
Contributor

@yuliiiah yuliiiah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions worked for me 🎉 I'm leaving some copy edits and leaving out the things we discussed because you know, I know, we both know 😎 Great job Caro!

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great additions, thank you @caroldelwing
Much more simpler to follow

@karl-cardenas-coding karl-cardenas-coding added the backport-version-4-3 Backport change to version 4.3 label Apr 15, 2024
@caroldelwing caroldelwing merged commit 7989300 into master Apr 15, 2024
15 checks passed
@caroldelwing caroldelwing deleted the doc-1038 branch April 15, 2024 20:27
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
(cherry picked from commit 7989300)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- ci: updated vale configuration (#2335)
version-4-2 Backport failed because of merge conflicts
version-4-3

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 2541

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
(cherry picked from commit 7989300)

Co-authored-by: caroldelwing <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review



* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review



* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
…R 2541 (#2651)

* docs: add guide for uploading packs to oci registries (#2541)

* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: reorganize folders

* docs: fix broken links

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request Apr 15, 2024
…R 2541 (#2653)

* docs: add guide for uploading packs to oci registries (#2541)

* docs: add guide for uploading packs to oci registries

* docs: move guide to the oci-registry folder

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* docs: apply suggestions from code review

* docs: add more suggestions from review

* docs: create separate guides, remove sub headings

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions

* docs: add an intro page, apply more suggestions

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: reorganize folders

* docs: fix broken link

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants