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

docs: some work on the migrade / upgration guide #6728

Draft
wants to merge 14 commits into
base: dev
Choose a base branch
from

Conversation

goto-bus-stop
Copy link
Member

This is not meant to "complete" the guide, just to group and expand the guidance to make it useful enough for dogfooding.

In this "first round" of work, I'm aiming to:

  • Make the individual items more useful to people (clearly say what has changed and why it's better for you; clearly say what you need to do)
  • Introduce a rough grouping of items (this is not necessarily meant as the final state: just to start off with something that can be more easily iterated on)

Drafting as neither item is complete.

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Feb 5, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed
* graphos/reference/upgrade/from-router-v1.mdx

Build ID: 55bc98af94e9ef76c40b5016

URL: https://www.apollographql.com/docs/deploy-preview/55bc98af94e9ef76c40b5016

This comment was marked as resolved.

@router-perf

This comment was marked as off-topic.


In 2.x, a spec-compliant [JSONPath](https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html) path is used, so a `$` is now required to select the root element:

```diff,yaml
Copy link
Member Author

Choose a reason for hiding this comment

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

I hope our docs system supports this. I think diff syntax would be the best way to show certain config changes.

Copy link
Member Author

Choose a reason for hiding this comment

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

Using normal yaml with comments instead for now.


</Note>
## Removals and deprecations
Copy link
Contributor

Choose a reason for hiding this comment

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

@goto-bus-stop - I copyedited the entries and reorganized them under new headings:

  • Removals and deprecations
  • Configuration changes
  • Functionality changes
  • New capabilities

Rather than spread the breaking changes under separate functionality-specific headings (e.g. telemetry, customizations, etc.), I wanted to present them at the top of the guide. That lead me to have Removals and deprecations first, then configuration and functionality changes. The New capabilities captures the new features that don't necessarily have breaking changes but we want to highlight and recommend.

Still have copyediting and perhaps some finer categorization within each heading. (The docs team has also discussed adding flags/labels/shields to categorize content. We haven't gotten around to implementing them, but this would be a great use-case in the near future.)

Copy link
Member Author

@goto-bus-stop goto-bus-stop Feb 7, 2025

Choose a reason for hiding this comment

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

Yes this is great! We used the new organisation during a trial run of the in-house upgrade and it worked quite well.

We also noted some points that would be useful to add to the guide, which i'll do some first drafts off today.

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.

3 participants