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: address tutorial suggestions #3980

Merged
merged 5 commits into from
Sep 20, 2024
Merged

Conversation

caroldelwing
Copy link
Contributor

@caroldelwing caroldelwing commented Sep 18, 2024

Describe the Change

This PR updates the Deploy a Custom Pack tutorial to address a few suggestions:

  • It replaces screenshots where our AWS account ID was visible.
  • It adds a few warnings about the Oras version and variable values.

Changed Pages

💻 Deploy a Custom Pack

Jira Tickets

🎫 DOC-1389

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-3-4 Backport change to version 3.4 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 backport-version-4-4 Backport change to version 4.4 labels Sep 18, 2024
Copy link

netlify bot commented Sep 18, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 0ff7356
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66ed72efb442be0008722e12
😎 Deploy Preview https://deploy-preview-3980--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 September 18, 2024 19:48
@caroldelwing caroldelwing requested a review from a team as a code owner September 18, 2024 19:48
@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 84.8%, saving 1.04 MB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-edit.webp 924.75 KB 126.65 KB -86.3% View diff
static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp 330.48 KB 63.60 KB -80.8% View diff

724 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 2%, saving 1.27 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp 63.60 KB 62.33 KB -2.0% View diff

725 images did not require optimisation.

Copy link
Contributor

@addetz addetz left a comment

Choose a reason for hiding this comment

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

Nice edits!

@caroldelwing caroldelwing merged commit 8ea96da into master Sep 20, 2024
17 checks passed
@caroldelwing caroldelwing deleted the update-packs-tutorial branch September 20, 2024 13:33
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

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

You might need to backport the following PRs to version-3-4:
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
version-4-1
version-4-2
version-4-3
version-4-4

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

Manual backport

To create the backport manually run:

backport --pr 3980

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 Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

Co-authored-by: caroldelwing <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

Co-authored-by: caroldelwing <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions (#3980)

* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

* docs: fix gitleaks

---------

Co-authored-by: caroldelwing <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions (#3980)

* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

* retrigger build

* docs: fix gitleaks

---------

Co-authored-by: caroldelwing <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Sep 20, 2024
* docs: address tutorial suggestions (#3980)

* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

* docs: fix gitleaks

---------

Co-authored-by: caroldelwing <[email protected]>
@caroldelwing
Copy link
Contributor Author

PS: I've just realized that branch 4-3 has an older version of the tutorial. Therefore, creating the 4-3 backport PR does not make sense.

caroldelwing added a commit that referenced this pull request Sep 24, 2024
* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This issue has been resolved in version 4.5.0 🎉

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-3-4 Backport change to version 3.4 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 backport-version-4-4 Backport change to version 4.4 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants