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

feat: add separate plugin for release notes with lenient broken link handling #52644

Open
wants to merge 12 commits into
base: devin/1738175449-upgrade-docusaurus
Choose a base branch
from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

This PR targets the following PR:


This PR adds a separate docs plugin instance for release notes with more lenient broken link handling. This allows us to:

  1. Keep strict broken link checking (throw) for main documentation
  2. Use warning-only broken link handling (warn) for release notes pages
  3. Maintain separate routing for release notes under /release-notes/

Changes:

  • Added new @docusaurus/plugin-content-docs instance for release notes
  • Configured lenient broken link handling for release notes
  • Excluded release notes from main docs to prevent duplicate processing

Link to Devin run: https://app.devin.ai/sessions/c6b12cf32eda4bfaa68496fc6a181eff

Copy link
Contributor Author

🤖 Devin AI Engineer

Original prompt from Aaron:

(Third try)

@devin - Take a look at this PR: https://github.com/airbytehq/airbyte/pull/52631

The current status is that specific pages are not found - and it looks like they don't exist. The broken links are specifically in our "release notes" pages, which are basically like blog posts and they sometimes link to pages that are later moved/deleted/consolidated. Can we set onBrokenLinks: 'warn' for these pages (or an equivalent) while keeping the 'throw' behavior to raise issues for the rest of the site?

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

vercel bot commented Jan 30, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ❌ Failed (Inspect) Jan 30, 2025 1:21am

…197882-separate-plugin-release-notes

Co-Authored-By: Aaron <AJ> Steers <[email protected]>
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants