Skip to content

Commit 8b40981

Browse files
Update breaking changes guide with how to use reusable content blocks (#68116)
## What <!-- * Describe what the change is solving. Link all GitHub issues related to this change. --> Updated the guide AJ produced for breaking connector changes. Adds instructions to use the block of generic connector upgrade information that can be added dynamically. ## How <!-- * Describe how code changes achieve the solution. --> ## Review guide <!-- 1. `x.py` 2. `y.py` --> ## User Impact <!-- * What is the end result perceived by the user? * If there are negative side effects, please list them. --> ## Can this PR be safely reverted and rolled back? <!-- * If unsure, leave it blank. --> - [x] YES 💚 - [ ] NO ❌ --------- Co-authored-by: Patrick Nilan <[email protected]>
1 parent e09ee0e commit 8b40981

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

docs/platform/connector-development/connector-breaking-changes.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ The breaking change metadata allows you to specify narrowed scopes, and specific
5353

5454
Your migration guide must be created as a separate file at `docs/integrations/{sources|destinations}/{connector-name}-migrations.md`. The guide should be detailed and user-focused, addressing the following for each breaking change version:
5555

56-
- **WHAT** - What changed: Specifically, what is fixed or better for the user after this change?
57-
- **WHY** - Why did we make this change? (API improvements, upstream deprecation, bug fixes, performance improvements).
58-
- **WHO** - Which users are affected? Be specific about streams, sync modes, or configuration options that are impacted.
56+
- **WHAT** - What changed? Specifically, what's fixed or better for the user after this change?
57+
- **WHY** - Why did you make this change? (API improvements, upstream deprecation, bug fixes, performance improvements).
58+
- **WHO** - Which users does this change affect? Be specific about streams, sync modes, or configuration options that are impacted.
5959
- **STEPS** - Exact steps users must take to migrate, including when to take them (before/after upgrade, before/after first sync).
6060

6161
Your migration guide can be as long as necessary and may include images, code snippets, SQL examples, and compatibility tables to help users understand and execute the migration.
@@ -69,6 +69,42 @@ Review these examples to understand the expected format and level of detail:
6969
- [Stripe Migration Guide](/integrations/sources/stripe-migrations) - Detailed sync mode and cursor field changes
7070
- [Snowflake Destination Migration Guide](/integrations/destinations/snowflake-migrations) - Use case-based migration paths
7171

72+
### Reusable Migration Content
73+
74+
It's desirable for a migration guide to instruct your reader how to plan for, execute, and clean up after an upgrade. This information is applicable to most upgrades for most connectors, and you shouldn't normally need to document it. A reusable content snippet exists at `docusaurus/static/_migration_guides_upgrade_guide.md`. It contains generic upgrade information shared by every connector, and you can import it into your migration guide seamlessly.
75+
76+
This avoids duplicating content, increases the likelihood that documentation remains up-to-date, and makes it easier to author your migration guide. The only migration content you should author in a bespoke fashion should focus on the specifics of this connector and connector version.
77+
78+
#### How to use the snippet
79+
80+
1. Import the reusable content into your doc as a React component.
81+
82+
```js title="mydoc.md"
83+
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';
84+
```
85+
86+
2. Display it.
87+
88+
```js title="mydoc.md"
89+
<MigrationGuide />
90+
```
91+
92+
#### Example usage
93+
94+
```md title="asana-migrations.md"
95+
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';
96+
97+
# Asana Migration Guide
98+
99+
## Upgrading to 1.0.0
100+
101+
Here are the details of this breaking change that are specific to Asana.
102+
103+
## Connector upgrade guide
104+
105+
<MigrationGuide />
106+
```
107+
72108
## Breaking Change Metadata Requirements
73109

74110
When adding a `breakingChanges` entry to your connector's `metadata.yaml` file, you must provide two critical fields:

0 commit comments

Comments
 (0)