Skip to content

Update docs for Apollo Federation v1 deprecation#526

Open
bhavberi wants to merge 3 commits intostrawberry-graphql:mainfrom
bhavberi:deprecate-fed-v1
Open

Update docs for Apollo Federation v1 deprecation#526
bhavberi wants to merge 3 commits intostrawberry-graphql:mainfrom
bhavberi:deprecate-fed-v1

Conversation

@bhavberi
Copy link

@bhavberi bhavberi commented Mar 4, 2026

Description

Apollo Federation v1 was deprecated in v0.285.0, but the Federation v1 docs don't show it. Updating the warning will help new users know about it.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

NA

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Documentation:

  • Update the Federation v1 documentation warning to highlight deprecation, direct users to the Federation v2 guide, and link to breaking changes for migration details.

@vercel
Copy link

vercel bot commented Mar 4, 2026

@bhavberi is attempting to deploy a commit to the Strawberry GraphQL Team on Vercel.

A member of the Team first needs to authorize it.

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 4, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the Apollo Federation v1 guide warning block to clearly state that Federation v1 is no longer supported and to direct users to Federation v2 and the 0.285.0 breaking changes documentation for migration details.

File-Level Changes

Change Details Files
Clarify deprecation of Apollo Federation v1 and update migration guidance links in the Federation v1 docs warning.
  • Replaces the existing warning text to explicitly state that Apollo Federation v1 is no longer supported by Strawberry and that users must migrate to Federation v2.
  • Updates the link text to direct users to the Federation v2 guide instead of describing it inline.
  • Adds a link to the 0.285.0 breaking changes documentation as the primary source for detailed migration instructions.
  • Removes the link to Apollo’s “What’s new in federation 2” external documentation from the warning block.
apps/frontend/src/content/docs/guides/federation-v1.mdx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the new warning text, the Federation v2 link has a double opening parenthesis ([Federation v2]((/docs/guides/federation))) which will break the markdown and should be corrected to a single (/) pair.
  • Consider preserving a link to Apollo’s “What’s new in federation 2” page alongside the breaking changes link, as it can still provide valuable conceptual context for users migrating from v1 to v2.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the new warning text, the Federation v2 link has a double opening parenthesis (`[Federation v2]((/docs/guides/federation))`) which will break the markdown and should be corrected to a single `(`/`)` pair.
- Consider preserving a link to Apollo’s “What’s new in federation 2” page alongside the breaking changes link, as it can still provide valuable conceptual context for users migrating from v1 to v2.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant