Upgrade to Docusaurus v3

.vscode/snowplow-docs.code-snippets

@@ -88,11 +88,11 @@
     "body": [":::info", "", "$0", "", ":::"],
     "description": "Info admonition"
   },
-  "Caution Admonition": {
+  "Warning Admonition": {
     "scope": "markdown",
-    "prefix": "admon_caution",
-    "body": [":::caution", "", "$0", "", ":::"],
-    "description": "Caution admonition"
+    "prefix": "admon_warning",
+    "body": [":::warning", "", "$0", "", ":::"],
+    "description": "Warning admonition"
   },
   "Danger Admonition": {
     "scope": "markdown",

babel.config.js

@@ -1,3 +1,6 @@
 module.exports = {
   presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  plugins: [],
+  // Ignore problematic plugin files during transpilation
+  ignore: ['**/node_modules/docusaurus-theme-github-codeblock/**/*.js'],
 }

docs/api-reference/loaders-storage-targets/bigquery-loader/_diagram.md

@@ -1,7 +1,6 @@
-```mdx-code-block
 import Mermaid from '@theme/Mermaid';
 import Link from '@docusaurus/Link';
-```
+
 <p>On {props.cloud}, the BigQuery Streaming Loader continually pulls events from {props.stream} and writes to BigQuery using the <Link to="https://cloud.google.com/bigquery/docs/write-api">BigQuery Storage API</Link>.</p>
 
 <Mermaid value={`

docs/api-reference/loaders-storage-targets/bigquery-loader/configuration-reference/_common_config.md

@@ -1,7 +1,7 @@
-```mdx-code-block
 import Link from '@docusaurus/Link';
-```
 
+<table>
+<tbody>
 <tr>
     <td><code>batching.maxBytes</code></td>
     <td>Optional. Default value <code>10000000</code>. Events are emitted to BigQuery when the batch reaches this size in bytes</td>
@@ -17,36 +17,36 @@ import Link from '@docusaurus/Link';
 <tr>
     <td><code>cpuParallelism.parseBytesFactor</code></td>
     <td>
-      Optional. Default value <code>0.1</code>.
-      Controls how many batches of bytes we can parse into enriched events simultaneously.
-      E.g. If there are 2 cores and <code>parseBytesFactor = 0.1</code> then only one batch gets processed at a time.
-      Adjusting this value can cause the app to use more or less of the available CPU.
+      <p>Optional. Default value <code>0.1</code>.</p>
+      <p>Controls how many batches of bytes we can parse into enriched events simultaneously.</p>
+      <p>E.g. If there are 2 cores and <code>parseBytesFactor = 0.1</code> then only one batch gets processed at a time.</p>
+      <p>Adjusting this value can cause the app to use more or less of the available CPU.</p>
     </td>
 </tr>
 <tr>
     <td><code>cpuParallelism.transformFactor</code></td>
     <td>
-      Optional. Default value <code>0.75</code>.
-      Controls how many batches of enriched events we can transform into BigQuery format simultaneously.
-      E.g. If there are 4 cores and <code>transformFactor = 0.75</code> then 3 batches gets processed in parallel.
-      Adjusting this value can cause the app to use more or less of the available CPU.
+      <p>Optional. Default value <code>0.75</code>.</p>
+      <p>Controls how many batches of enriched events we can transform into BigQuery format simultaneously.</p>
+      <p>E.g. If there are 4 cores and <code>transformFactor = 0.75</code> then 3 batches gets processed in parallel.</p>
+      <p>Adjusting this value can cause the app to use more or less of the available CPU.</p>
     </td>
 </tr>
 <tr>
     <td><code>retries.setupErrors.delay</code></td>
     <td>
-      Optional. Default value <code>30 seconds</code>.
-      Configures exponential backoff on errors related to how BigQuery is set up for this loader.
-      Examples include authentication errors and permissions errors.
-      This class of errors are reported periodically to the monitoring webhook.
+      <p>Optional. Default value <code>30 seconds</code>.</p>
+      <p>Configures exponential backoff on errors related to how BigQuery is set up for this loader.</p>
+      <p>Examples include authentication errors and permissions errors.</p>
+      <p>This class of errors are reported periodically to the monitoring webhook.</p>
     </td>
 </tr>
 <tr>
     <td><code>retries.transientErrors.delay</code></td>
     <td>
-      Optional. Default value <code>1 second</code>.
-      Configures exponential backoff on errors that are likely to be transient.
-      Examples include server errors and network errors.
+      <p>Optional. Default value <code>1 second</code>.</p>
+      <p>Configures exponential backoff on errors that are likely to be transient.</p>
+      <p>Examples include server errors and network errors.</p>
     </td>
 </tr>
 <tr>
@@ -56,33 +56,34 @@ import Link from '@docusaurus/Link';
 <tr>
     <td><code>skipSchemas</code></td>
     <td>
-      Optional, e.g. <code>["iglu:com.example/skipped1/jsonschema/1-0-0"]</code> or with wildcards <code>["iglu:com.example/skipped2/jsonschema/1-*-*"]</code>.
-      A list of schemas that won't be loaded to BigQuery.
-      This feature could be helpful when recovering from edge-case schemas which for some reason cannot be loaded to the table.
+      <p>Optional, e.g. <code>\["iglu:com.example/skipped1/jsonschema/1-0-0"]</code> or with wildcards <code>\["iglu:com.example/skipped2/jsonschema/1-*-*"]</code>.</p>
+      <p>A list of schemas that won't be loaded to BigQuery.</p>
+      <p>This feature could be helpful when recovering from edge-case schemas which for some reason cannot be loaded to the table.</p>
     </td>
 </tr>
 <tr>
     <td><code>legacyColumnMode</code></td>
-    <td>Optional. Default value <code>false</code>.
-      When this mode is enabled, the loader uses the legacy column style used by the v1 BigQuery loader.
-      For example, an entity for a <code>1-0-0</code> schema is loaded into a column ending in <code>_1_0_0</code>, instead of a column ending in <code>_1</code>.
-      This feature could be helpful when migrating from the v1 loader to the v2 loader.
+    <td>
+      <p>Optional. Default value <code>false</code>.</p>
+      <p>When this mode is enabled, the loader uses the legacy column style used by the v1 BigQuery loader.</p>
+      <p>For example, an entity for a <code>1-0-0</code> schema is loaded into a column ending in <code>_1_0_0</code>, instead of a column ending in <code>_1</code>.</p>
+      <p>This feature could be helpful when migrating from the v1 loader to the v2 loader.</p>
     </td>
 </tr>
 <tr>
     <td><code>legacyColumns</code></td>
     <td>
-      Optional, e.g. <code>["iglu:com.example/legacy/jsonschema/1-0-0"]</code> or with wildcards <code>["iglu:com.example/legacy/jsonschema/1-*-*"]</code>.
-      Schemas for which to use the legacy column style used by the v1 BigQuery loader, even when <code>legacyColumnMode</code> is disabled.
+      <p>Optional, e.g. <code>\["iglu:com.example/legacy/jsonschema/1-0-0"]</code> or with wildcards <code>\["iglu:com.example/legacy/jsonschema/1-*-*"]</code>.</p>
+      <p>Schemas for which to use the legacy column style used by the v1 BigQuery loader, even when <code>legacyColumnMode</code> is disabled.</p>
     </td>
 </tr>
 <tr>
     <td><code>exitOnMissingIgluSchema</code></td>
     <td>
-      Optional. Default value <code>true</code>.
-      Whether the loader should crash and exit if it fails to resolve an Iglu Schema.
-      We recommend `true` because Snowplow enriched events have already passed validation, so a missing schema normally indicates an error that needs addressing.
-      Change to <code>false</code> so events go the failed events stream instead of crashing the loader.
+      <p>Optional. Default value <code>true</code>.</p>
+      <p>Whether the loader should crash and exit if it fails to resolve an Iglu Schema.</p>
+      <p>We recommend <code>true</code> because Snowplow enriched events have already passed validation, so a missing schema normally indicates an error that needs addressing.</p>
+      <p>Change to <code>false</code> so events go the failed events stream instead of crashing the loader.</p>
     </td>
 </tr>
 <tr>
@@ -127,13 +128,15 @@ import Link from '@docusaurus/Link';
 </tr>
 <tr>
     <td><code>telemetry.disable</code></td>
-    <td>Optional. Set to <code>true</code> to disable <Link to="/docs/getting-started-on-community-edition/telemetry/">telemetry</Link>.</td>
+    <td>Optional. Set to <code>true</code> to disable <Link to="/docs/get-started/self-hosted/telemetry/">telemetry</Link>.</td>
 </tr>
 <tr>
     <td><code>telemetry.userProvidedId</code></td>
-    <td>Optional. See <Link to="/docs/getting-started-on-community-edition/telemetry/#how-can-i-help">here</Link> for more information.</td>
+    <td>Optional. See <Link to="/docs/get-started/self-hosted/telemetry/#how-can-i-help">here</Link> for more information.</td>
 </tr>
 <tr>
     <td><code>http.client.maxConnectionsPerServer</code></td>
     <td> Optional. Default value 4. Configures the internal HTTP client used for iglu resolver, alerts and telemetry. The maximum number of open HTTP requests to any single server at any one time.</td>
 </tr>
+</tbody>
+</table>

docs/api-reference/loaders-storage-targets/schemas-in-warehouse/index.md

@@ -43,7 +43,7 @@ The name of each column is the name of the schema field converted to snake case.
 
 :::
 
-:::caution
+:::warning
 
 If an event or entity includes fields not defined in the schema, those fields will not be stored in the warehouse.
 
@@ -107,7 +107,7 @@ The name of each record field is the name of the schema field converted to snake
 
 :::
 
-:::caution
+:::warning
 
 If an event or entity includes fields not defined in the schema, those fields will not be stored in the warehouse.
 
@@ -196,7 +196,7 @@ The name of each record field is the name of the schema field converted to snake
 
 :::
 
-:::caution
+:::warning
 
 If an event or entity includes fields not defined in the schema, those fields will not be stored in the warehouse.
 
@@ -213,6 +213,53 @@ For example, suppose you have the following field in the schema:
 
 It will be translated into a field called `last_name` (notice the underscore), of type `STRING`.
 
+  </TabItem>
+  <TabItem value="synapse" label="Synapse Analytics">
+
+Each type of self-describing event and each type of entity get their own dedicated columns in the underlying data lake table. The name of such a column is composed of the schema vendor, schema name and major schema version (more on versioning [later](#versioning)).
+
+The column name is prefixed by `unstruct_event_` for self-describing events, and by `contexts_` for entities. _(In case you were wondering, those are the legacy terms for self-describing events and entities, respectively.)_
+
+:::note
+
+All characters are converted to lowercase and all symbols (like `.`) are replaced with an underscore.
+
+:::
+
+Examples:
+
+| Kind                  | Schema                                      | Resulting column                                   |
+| --------------------- | ------------------------------------------- | -------------------------------------------------- |
+| Self-describing event | `com.example/button_press/jsonschema/1-0-0` | `events.unstruct_event_com_example_button_press_1` |
+| Entity                | `com.example/user/jsonschema/1-0-0`         | `events.contexts_com_example_user_1`               |
+
+The column will be formatted as JSON — an object for self-describing events and an array of objects for entities (because an event can have more than one entity attached).
+
+Inside the JSON object, there will be fields corresponding to the fields in the schema.
+
+:::note
+
+The name of each JSON field is the name of the schema field converted to snake case.
+
+:::
+
+:::warning
+
+If an event or entity includes fields not defined in the schema, those fields will not be stored in the data lake, and will not be availble in Synapse.
+
+:::
+
+For example, suppose you have the following field in the schema:
+
+```json
+"lastName": {
+  "type": "string",
+  "maxLength": 100
+}
+```
+
+It will be translated into a field called `last_name` (notice the underscore) inside the JSON object.
+
   </TabItem>
 </Tabs>
 

docs/api-reference/loaders-storage-targets/snowplow-rdb-loader/transforming-enriched-data/spark-transformer/index.md

@@ -45,7 +45,7 @@ where `region` is one of `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`, `eu
 
 ## Configuring the EMR cluster
 
-:::caution
+:::warning
 
 Starting from version `5.5.0`, batch transformer requires to use Java 11 on EMR ([default is Java 8](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/configuring-java8.html)). See the `bootstrapActionConfigs` section in the configuration below.