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: upgrade to docusaurus 3.2.1 DOC-1134 #2589

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

addetz
Copy link
Contributor

@addetz addetz commented Apr 5, 2024

Describe the Change

This patch makess the following changes:

Note: technically the existing contentLoaded already received the allContent, but it was a secret undocumented feature (only used by our debug plugin) that is now replaced by this brand-new lifecycle. I won't consider this as a breaking change.

Changed Pages

💻 Add Preview URL for Page

Jira Tickets

🎫 DOC-1134

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.

This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta
Copy link

netlify bot commented Apr 5, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit e112c25
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66100f683015a2000854a68a
😎 Deploy Preview https://deploy-preview-2589--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 added the visual-tests Trigger the visual tests workflow label Apr 5, 2024
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.

Looks great. The visual comparison for the API pages reveal that the openapi plugin added some whitespace after the page title. Everything looks great.

@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-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 labels Apr 5, 2024
@addetz addetz merged commit e06f436 into master Apr 5, 2024
35 checks passed
@addetz addetz deleted the upgrade-docusaurus-doc-1134 branch April 5, 2024 17:58
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
version-4-0
version-3-4
version-4-1
version-4-2

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 Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 5, 2024
This patch makess the following changes:
- Upgrades Docusaurus to 3.2.1
- Fixes breaking changes with `contentLoaded` function
- Upgrades `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` to the newest beta

(cherry picked from commit e06f436)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
Copy link
Contributor

github-actions bot commented Apr 5, 2024

📋 Visual Report for branch upgrade-docusaurus-doc-1134 with CI run 8573719797 and attempt 1 is ready at
https://spectrocloud.github.io/librarium/reports/upgrade-docusaurus-doc-1134/8573719797/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.

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@diemol
Copy link

diemol commented Apr 12, 2024

Thank you for figuring this out, @addetz! It helped me move to 3.2.1 as well.

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 released visual-tests Trigger the visual tests workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants