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: change simple cards to use versioned link DOC-1502 #4971

Merged
merged 10 commits into from
Dec 13, 2024
Merged

docs: change simple cards to use versioned link DOC-1502 #4971

merged 10 commits into from
Dec 13, 2024

Conversation

addetz
Copy link
Contributor

@addetz addetz commented Dec 10, 2024 •
edited
Loading

Describe the Change

This PR contains:

  • changes to the simple card component to use the VersionedLink under the covers
  • changes to all usages of the simple card grid to use the new syntax
  • replace 2 missing images referenced in the README
  • add the README to the unused images job so missing images are not deleted again

Changed Pages

No user facing changes.

Jira Tickets

🎫 DOC-1502

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.

@addetz addetz 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-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 backport-version-4-5 Backport changes to the version-4-5 branch. labels Dec 10, 2024
@netlify Netlify
Copy link

netlify bot commented Dec 10, 2024 •
edited
Loading

✅ Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 5980b29
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/675c4c590c1653000818c005
😎 Deploy Preview https://deploy-preview-4971--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.

@addetz addetz force-pushed the add-versioned-link-cards-doc-1502 branch from c247188 to 10272dd Compare December 10, 2024 21:07
@addetz addetz force-pushed the add-versioned-link-cards-doc-1502 branch from 2f749c2 to 6b937de Compare December 12, 2024 13:16
@addetz addetz marked this pull request as ready for review December 12, 2024 13:23
@addetz addetz requested a review from a team as a code owner December 12, 2024 13:23
@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 1.7%, saving 72 bytes.

Filename Before After Improvement Visual comparison
static/assets/docs/images/hide_copy_button.webp 4.18 KB 4.11 KB -1.7% View diff

770 images did not require optimisation.

karl-cardenas-coding
karl-cardenas-coding approved these changes Dec 12, 2024
View reviewed changes
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.

Thanks for tackling this @addetz

@addetz addetz added the visual-tests Trigger the visual tests workflow label Dec 13, 2024
@github-actions GitHub Actions
Copy link
Contributor

📋 Visual Report for branch add-versioned-link-cards-doc-1502 with CI run 12317387785 and attempt 1 is ready at
https://spectrocloud.github.io/librarium/reports/add-versioned-link-cards-doc-1502/12317387785/1

💡 You may have to wait for DNS to resolve or the GitHub Pages job to complete. You can view the progress of the GitHub Pages job here.

@addetz addetz removed the visual-tests Trigger the visual tests workflow label Dec 13, 2024
@addetz
Copy link
Contributor Author

addetz commented Dec 13, 2024

The visual test failures are due to unrelated changes that have been made. No errors caused by this PR, so I consider visual tests passed ✅

@addetz addetz merged commit ab95159 into master Dec 13, 2024
19 checks passed
@addetz addetz deleted the add-versioned-link-cards-doc-1502 branch December 13, 2024 15:17
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
52bc6d6 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
81b6030 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
a2a68ee 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
7de8c2d 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
394ab54 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 13, 2024
@addetz
docs: change simple cards to use versioned link DOC-1502 (#4971)
662530b 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit ab95159)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 13, 2024
Merged
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ version-4-0
✅ version-3-4
✅ version-4-2
✅ version-4-3
✅ version-4-4
✅ version-4-5

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

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 Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5044)
680e1e7 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5043)
2122423 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5045)
b64783c 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5047)
80df985 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5046)
c8c627b 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Dec 13, 2024
@vault-token-factory-spectrocloud @addetz
docs: change simple cards to use versioned link DOC-1502 (#4971) (#5048)
699d878 
* docs: change simple cards to use versioned link DOC-1502

* docs: fix bad link

* docs: add versioned link test cases

* docs: add readme to used images list

* docs: skip vale on additional capabilities page

* Optimised images with calibre/image-actions

* docs: adjust readme

* docs: remove wrongly added div

---------

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

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@karl-cardenas-coding karl-cardenas-coding karl-cardenas-coding approved these changes

@caroldelwing caroldelwing Awaiting requested review from caroldelwing caroldelwing is a code owner automatically assigned from spectrocloud/docs-education

@achuribooks achuribooks Awaiting requested review from achuribooks achuribooks is a code owner automatically assigned from spectrocloud/docs-education

Assignees
No one assigned
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-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 backport-version-4-5 Backport changes to the version-4-5 branch.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@addetz @karl-cardenas-coding