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 Docusaurus to 3.7.x #52636

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/managing-airbyte/connector-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Each connector's changelog details its update history. You can find it in the [c
### Airbyte Cloud
**Minor and Patch Versions:** These are applied automatically and immediately to your instance. You don't need to take any action.

**Major Versions:** A major version will include notable changes that affect your schema or sync success. We will notify you ahead of time to give you a window to prepare for the change. At the end of the window, we will automatically upgrade your connector to ensure you receive the latest updates. Examples of major version changes are shared in our [breaking change documentation](./using-airbyte/schema-change-management#major-connector-version-upgrades).
**Major Versions:** A major version will include notable changes that affect your schema or sync success. We will notify you ahead of time to give you a window to prepare for the change. At the end of the window, we will automatically upgrade your connector to ensure you receive the latest updates. Examples of major version changes are shared in our [breaking change documentation](/using-airbyte/schema-change-management#major-connector-version-upgrades).

## Airbyte Open Source (OSS) and Self-Managed Enterprise (SME)

Expand Down Expand Up @@ -60,4 +60,4 @@ Major updates may require you to adjust connection settings or even make changes

:::info
Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You will always need to manually update for major version bumps.
:::
:::
2 changes: 1 addition & 1 deletion docs/release_notes/april_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In addition to our improved schema discovery, we also released:

- Reduced friction for large records. Airbyte's platform no longer limits how large a record from the source can be. Instead, each destination has their own unique limit constraints. When a destination receives a large record, the primary key and cursor will be retained, but all other data in the record will be nulled. Any modifications to the record will be stored within `airbyte_meta.changes` for your review within the destination.

- A new OSS [Quickstart](/deploying-airbyte/quickstart) that automatically manages all install steps for you. Mac users can also use Brew to install the `abctl` command.
- A new OSS [Quickstart](/using-airbyte/getting-started/oss-quickstart) that automatically manages all install steps for you. Mac users can also use Brew to install the `abctl` command.

- (Self-Managed Enterprise only) Improvements to connection migrations. Any changes to authentication or ingress URL configurations can be saved without deleting state. The improvement also includes a backwards-compatible alternative to setting the webapp-url property through the airbyte.yml file.

Expand Down
8 changes: 4 additions & 4 deletions docs/release_notes/july_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This page includes new features and improvements to the Airbyte Cloud and Airbyt

## ✨ Highlights

[Native authentication](https://github.com/airbytehq/airbyte/issues/41634) by email and password is available in Airbyte OSS so that any instance of Airbyte is secure by default. The newest version of `abctl` (v0.11.0) now generates the credentials randomly and you can use `abctl local credentials` to retrieve them. See our [quickstart docs](using-airbyte/getting-started/oss-quickstart#2-run-airbyte) for more details. For more detailed documentation about authentication, see our docs [here](/deploying-airbyte/integrations/authentication).
[Native authentication](https://github.com/airbytehq/airbyte/issues/41634) by email and password is available in Airbyte OSS so that any instance of Airbyte is secure by default. The newest version of `abctl` (v0.11.0) now generates the credentials randomly and you can use `abctl local credentials` to retrieve them. See our [quickstart docs](/using-airbyte/getting-started/oss-quickstart#part-2-run-airbyte) for more details. For more detailed documentation about authentication, see our docs [here](/deploying-airbyte/integrations/authentication).

We have also released rate limited messaging, providing users more transparency into what's going on with their syncs. When a source is rate limited, it can not only tell the platform but also include a timestamp when the API is expected to be available again to resume extracting records. This is used to tell users the connection is being rate limited, and if the timestamp is provided we include a countdown to when Airbyte will start syncing again.

Expand All @@ -15,7 +15,7 @@ We have also released rate limited messaging, providing users more transparency

## Platform Releases

- [Workloads](https://github.com/airbytehq/airbyte/discussions/42947) have been released with Airbyte Helm Chart `0.390.0`, which provides a more scalable and reliable architecture to run sync jobs by separating scheduling and orchestration from data movement tasks. This improvement unlocks more automated management of workloads by managing job spikes and enables horizonal scaling (for Cloud and Enterprise users). Read more about the Workloads feature in our [docs](understanding-airbyte/jobs#workloads) or [blog post](https://airbyte.com/blog/introducing-workloads-how-airbyte-1-0-orchestrates-data-movement-jobs).
- [Workloads](https://github.com/airbytehq/airbyte/discussions/42947) have been released with Airbyte Helm Chart `0.390.0`, which provides a more scalable and reliable architecture to run sync jobs by separating scheduling and orchestration from data movement tasks. This improvement unlocks more automated management of workloads by managing job spikes and enables horizonal scaling (for Cloud and Enterprise users). Read more about the Workloads feature in our [docs](/understanding-airbyte/jobs) or [blog post](https://airbyte.com/blog/introducing-workloads-how-airbyte-1-0-orchestrates-data-movement-jobs).

- Managing and obtaining API keys is now consistent across all our products. We have brought our API portal in-house and API keys can now be generated and found in the “Applications” page of our UI. Along with this, the Terraform provider and Java/Python SDKs have been updated to automatically retrieve tokens between each action, so that users don’t need to worry about fetching tokens themselves.

Expand All @@ -34,7 +34,7 @@ We also released a few notable improvements for our connectors:

- Source S3 has become faster! With CDK 2.0, the protocol now uses Pydantic V2 and removes the serialization of each record. As connectors are updated to the new CDK version, additional connectors will see varying levels of speed improvements.

- Destination Redshift (v3.3.0) and Snowflake (v3.11.0) support [Refreshes](operator-guides/refreshes), which reduces data downtime when resyncing historical data. They join BigQuery in also supporting [Resumable Full Refresh](https://airbyte.com/blog/resumable-full-refresh-building-resilient-systems-for-syncing-data), which ensures the success of large Full Refresh syncs.
- Destination Redshift (v3.3.0) and Snowflake (v3.11.0) support [Refreshes](/operator-guides/refreshes), which reduces data downtime when resyncing historical data. They join BigQuery in also supporting [Resumable Full Refresh](https://airbyte.com/blog/resumable-full-refresh-building-resilient-systems-for-syncing-data), which ensures the success of large Full Refresh syncs.

- Connector Builder has added support for `regex_search` to ease filtering for substrings

Expand All @@ -48,4 +48,4 @@ We also released a few notable improvements for our connectors:
## Announcements


- As we prepare to deprecate Docker Compose, we published a [migration guide](using-airbyte/getting-started/oss-quickstart#migrating-from-docker-compose-optional) for those migrating from Docker Compose to abctl.
- As we prepare to deprecate Docker Compose, we published a [migration guide](https://airbyte.com/blog/understand-and-troubleshoot-your-migration-to-abctl) for those migrating from Docker Compose to abctl.
2 changes: 1 addition & 1 deletion docs/release_notes/june_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This page includes new features and improvements to the Airbyte Cloud and Airbyt

## ✨ Highlights

Airbyte added [Refresh](operator-guides/refreshes) support for our BigQuery destination, which brings an improved experience to resyncing all of your data again. This enables data to never be deleted from final tables during a historical resyncing of data. More certified destinations will support Refresh in the coming weeks.
Airbyte added [Refresh](/operator-guides/refreshes) support for our BigQuery destination, which brings an improved experience to resyncing all of your data again. This enables data to never be deleted from final tables during a historical resyncing of data. More certified destinations will support Refresh in the coming weeks.

Users can now monitor the incremental progress of syncs on the Connection Status page. The sync progress feature displays record counts and sync duration for each stream during a sync, as well as which streams are syncing and when a connection sync is actively running. The Connection Status Page also now shows counts from the last time each enabled stream synced. Lastly, each stream individually displays stream status, which helps users troubleshoot by indicating exactly which streams are erroring.

Expand Down
4 changes: 2 additions & 2 deletions docs/using-airbyte/schema-change-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ When publishing a new version of a connector, Airbyte only considers the followi
| Destination Format / Normalization Change | The way the destination writes the final data or how Airbyte cleans that data is changing in a way that requires a full refresh |
| State Changes | The format of the source’s state has changed, and the full dataset will need to be re-synced |

We expect that most users will gracefully continue syncing successfully with most major version updates. However, users using a destination that does not utilize [Typing & Deduping](./using-airbyte/core-concepts/typing-deduping) will experience sync failures if the major version includes a data type change.
We expect that most users will gracefully continue syncing successfully with most major version updates. However, users using a destination that does not utilize [Typing & Deduping](/using-airbyte/core-concepts/typing-deduping) will experience sync failures if the major version includes a data type change.


### Upgrading your connector
Expand All @@ -134,4 +134,4 @@ To review major connector version changes and upgrade your connector:

2. Review the description of what has changed in the new version. The major version change will require you to upgrade your source or destination to a new version by a specific cutoff date.

3. Update the source or destination to the new version to continue syncing. Follow the connector-specific migration guide to ensure your connections continue syncing successfully.
3. Update the source or destination to the new version to continue syncing. Follow the connector-specific migration guide to ensure your connections continue syncing successfully.
4 changes: 3 additions & 1 deletion docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ const config = {
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/airbytehq/airbyte/blob/master/docs",
path: "../docs",
exclude: ["**/*.inapp.md"],
exclude: [
"**/*.inapp.md"
],
beforeDefaultRemarkPlugins: [specDecoration, connectorList], // use before-default plugins so TOC rendering picks up inserted headings
remarkPlugins: [
docsHeaderDecoration,
Expand Down
22 changes: 11 additions & 11 deletions docusaurus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,17 @@
"@babel/runtime-corejs3": "7.23.6",
"@cmfcmf/docusaurus-search-local": "^1.1.0",
"@docsearch/react": "3.1.0",
"@docusaurus/core": "^3.0.1",
"@docusaurus/cssnano-preset": "^3.0.1",
"@docusaurus/module-type-aliases": "^3.0.1",
"@docusaurus/plugin-client-redirects": "^3.0.1",
"@docusaurus/plugin-debug": "^3.0.1",
"@docusaurus/plugin-sitemap": "^3.0.1",
"@docusaurus/preset-classic": "^3.0.1",
"@docusaurus/theme-classic": "^3.0.1",
"@docusaurus/theme-mermaid": "^3.0.1",
"@docusaurus/theme-search-algolia": "^3.0.1",
"@docusaurus/types": "^3.0.1",
"@docusaurus/core": "^3.7.0",
"@docusaurus/cssnano-preset": "^3.7.0",
"@docusaurus/module-type-aliases": "^3.7.0",
"@docusaurus/plugin-client-redirects": "^3.7.0",
"@docusaurus/plugin-debug": "^3.7.0",
"@docusaurus/plugin-sitemap": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/theme-classic": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
"@docusaurus/theme-search-algolia": "^3.7.0",
"@docusaurus/types": "^3.7.0",
"@fortawesome/fontawesome-svg-core": "^6.5.1",
"@fortawesome/free-brands-svg-icons": "^6.7.1",
"@fortawesome/free-regular-svg-icons": "^6.5.1",
Expand Down
Loading
Loading