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

chore: upgrade to docusarus v3 #1914

Merged
merged 20 commits into from
Jan 11, 2024
Merged

chore: upgrade to docusarus v3 #1914

merged 20 commits into from
Jan 11, 2024

Conversation

lennessyy
Copy link
Contributor

Describe the Change

This PR upgrades the docusaurus version used by the site to docusaurus v3.0.1

Review Changes

💻 Add Preview URL

🎫 Jira Ticket

Copy link

netlify bot commented Dec 18, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 33ab314
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/659f36cd55b3a40008ae9480
😎 Deploy Preview https://deploy-preview-1914--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.

@@ -49,7 +49,7 @@ export default function CodeBlockString({
>
{title && <div className={styles.codeBlockTitle}>{title}</div>}
<div className={styles.codeBlockContent}>
<Highlight {...defaultProps} theme={prismTheme} code={code} language={language ?? "text"}>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I investigated this one. defaultProps is not being exported anymore. The old defaultProps.js file just has the following content:

import Prism from "prism-react-renderer/prism";
import theme from "prism-react-renderer/themes/duotoneDark"; // Adjust the theme import based on availability

<Highlight Prism={Prism} theme={theme} code={code} language={language ?? "text"}>
    {/* rest of your component code */}
</Highlight>

I haven't found this to really do anything? so I simply removed it.

@@ -9,7 +9,7 @@ import {
} from "@docusaurus/theme-common";
import {
isActiveSidebarItem,
findFirstCategoryLink,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This function is no longer being exported. I think the replacement covers the functionality of the old function.

@karl-cardenas-coding karl-cardenas-coding added enhancement New feature or request javascript Pull requests that update Javascript code labels Dec 22, 2023
@lennessyy lennessyy marked this pull request as ready for review January 8, 2024 20:59
@lennessyy lennessyy requested a review from a team as a code owner January 8, 2024 20:59
| `before-reset` | This stage executes before reset. | |
| Stage | Description |
| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'rootfs'?

| `before-reset` | This stage executes before reset. | |
| Stage | Description |
| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'initrd'?

| `before-reset` | This stage executes before reset. | |
| Stage | Description |
| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'chroot'?

| Stage | Description |
| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
| `initramfs` | This is still an early stage, running before switching to root. Here you can apply changes to the booting setup of Elemental. Despite executing this before switching to root, this invocation is chrooted into the target root after the immutable rootfs is set up and ready. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'chrooted'?

| Stage | Description |
| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
| `initramfs` | This is still an early stage, running before switching to root. Here you can apply changes to the booting setup of Elemental. Despite executing this before switching to root, this invocation is chrooted into the target root after the immutable rootfs is set up and ready. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'rootfs'?

| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
| `initramfs` | This is still an early stage, running before switching to root. Here you can apply changes to the booting setup of Elemental. Despite executing this before switching to root, this invocation is chrooted into the target root after the immutable rootfs is set up and ready. |
| `boot` | This stage executes after initramfs has switched to root and during the systemd boot-up process. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'initramfs'?

| ---- | ---- |
| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
| `initramfs` | This is still an early stage, running before switching to root. Here you can apply changes to the booting setup of Elemental. Despite executing this before switching to root, this invocation is chrooted into the target root after the immutable rootfs is set up and ready. |
| `boot` | This stage executes after initramfs has switched to root and during the systemd boot-up process. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'systemd'?

| `rootfs` | This is the earliest stage, running before switching to root. It happens right after the root is mounted in /sysroot and before applying the immutable rootfs configuration. This stage is executed over initrd root, no chroot is applied. |
| `initramfs` | This is still an early stage, running before switching to root. Here you can apply changes to the booting setup of Elemental. Despite executing this before switching to root, this invocation is chrooted into the target root after the immutable rootfs is set up and ready. |
| `boot` | This stage executes after initramfs has switched to root and during the systemd boot-up process. |
| `fs` | This stage is executed when fs is mounted and is guaranteed to have access to the state and persistent partitions ( COS_STATE and COS_PERSISTENT respectively). |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'fs'?

| `after-install` | This stage executes after the installation of the OS. |
| `after-install-chroot` | This stage executes after the installation of the OS ends. |
| `after-upgrade` | This stage executes after the OS upgrade ends. |
| `after-upgrade-chroot` | This stage executes after the OS upgrade ends (chroot call). |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'chroot'?

| `after-upgrade` | This stage executes after the OS upgrade ends. |
| `after-upgrade-chroot` | This stage executes after the OS upgrade ends (chroot call). |
| `after-reset` | This stage executes after the OS resets. |
| `after-reset-chroot` | This stage executes after the OS resets (chroot call). |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'chroot'?

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.

Approved 🚀

@lennessyy lennessyy enabled auto-merge (squash) January 11, 2024 00:43
@lennessyy lennessyy merged commit 9e3ffef into master Jan 11, 2024
10 checks passed
@lennessyy lennessyy deleted the docusaurus-v3 branch January 11, 2024 00:45
@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 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request javascript Pull requests that update Javascript code released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants