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

Remaining AC3 documentation updates #6429

Merged
merged 53 commits into from
Jul 14, 2020
Merged

Remaining AC3 documentation updates #6429

merged 53 commits into from
Jul 14, 2020

Conversation

hwillson
Copy link
Member

@hwillson hwillson commented Jun 11, 2020

This PR houses and tracks the remaining AC3 documentation work that needs to be completed for launch.

TODO:

  • Remaining local state updates
    • Handling @client fields with field policies
      • add a mutation example
      • add a merge function example
    • Using reactive variables to track @client state
    • Integrating @client into remote queries
    • Handling async operations with field policies and reactive variables
    • Handling @client fields with the cache
    • Using @client fields as variables
    • Client side schema
    • Refactor content layout
      • Combine updating/querying local state
      • Adjust all subsections to be l2's to show in right hand menu
      • Deprecate in local resolvers title
  • Remove broken Meteor docs
  • Consider cache policies vs. field policies specific naming
  • Remove all Apollo Component docs examples
  • cache.modify
    • Be sure to demonstrate both updating and removal
  • cache.identify
  • Migration guide for moving from local resolvers to cache policies
  • @apollo/client/core, @apollo/client/utilities, @apollo/client/testing, @apollo/client/cache entry points
  • canRead and readField helpers
  • cache.evict(id, fieldName) changes to support specific entity field eviction
  • readQuery / writeQuery API updates (e.g. options.id)
  • Remove all FragmentMatcher, HeuristicFragmentMatcher, and IntrospectionFragmentMatcher references
  • Explain new cache console.log warnings, what they mean, how to resolve them
  • How to address dangling references
  • Fall back to cache-first after cache-and-network or network-only (8ce2b4f)
  • Update all read / merge docs to make sure they reflect the final version of the API
  • Replace all mentions of node-fetch with cross-fetch (fdcd519)
  • Silencing broadcasting (Allow silencing broadcast for cache update methods. #6288)
  • Review migration guide to make sure all important/common path breaking changes are mentioned
  • Consider updating the intro path to mutations to replace the new default approach of using cache.modify with a readQuery / writeQuery approach instead (then briefly mention cache.modify as a more advanced alternative)
  • Make sure @live support removal is mentioned somewhere
  • Update the migration guide
    • Mention local state management changes, including reactive variables
    • Outline how to migrate from local resolvers to cache policies
    • Decide if we want to highlight important breaking changes, or refer to the CHANGELOG (as we're duplicating details)
  • Consider adding a InMemoryCache section under API - CORE explaining main API cache functions and options
  • Make sure all cacheRedirects mentions/examples have been replaced with type policies
  • Refactor all pagination documentation
  • Deprecate fetchMode's updateQuery, replacing with field policies (Deprecate fetchMore updateQuery function, and provide basic field policy helper functions #6464)
  • Remove broken Performance > Query splitting section
  • Decide if we want to write a new Performance > Query splitting section using read and merge functions
  • Replace cache.makeVar references to direct makeVar imports (Make makeVar a global function instead of a method of InMemoryCache. #6512)

@hwillson hwillson self-assigned this Jun 11, 2020
@hwillson hwillson added this to the Release 3.0 milestone Jun 11, 2020
@hwillson hwillson force-pushed the more-ac3-docs-tweaks branch 6 times, most recently from ce9881a to 23af213 Compare June 23, 2020 15:54
@hwillson
Copy link
Member Author

@StephenBarlow @benjamn @jcreighton I'll take this out of draft as I think there's starting to be a bit much to review all at once. I'll continue working on the outstanding todo items in separate PR's off of this one. As far as reviewing goes, commit by commit should be a reasonable path.

One quick thing to note @stephen - I don't think there's any value in reviewing the Local resolvers (DEPRECATED) page. I've removed a few sections that are no longer needed, but other than that we're going to be removing local resolvers completely in the next major AC version. Maybe just a quick review to make sure the deprecation warning message is okay?

Oh, and one more thing - Netlify doc previews are currently broken for all AC PR's. I'll follow up with @trevorblades on this.

Thanks all!

@hwillson hwillson force-pushed the more-ac3-docs-tweaks branch from 23af213 to 1791433 Compare June 23, 2020 18:40
@hwillson hwillson marked this pull request as ready for review June 23, 2020 18:40
@hwillson hwillson requested a review from StephenBarlow as a code owner June 23, 2020 18:40
@hwillson hwillson requested review from benjamn and jcreighton June 23, 2020 18:41
@hwillson hwillson force-pushed the more-ac3-docs-tweaks branch from 1791433 to cdbef37 Compare June 24, 2020 14:50
@StephenBarlow
Copy link
Contributor

Green to go for tomorrow! I'll try to get some eyes on the preview docs today, and we can of course follow up quickly with any hiccups folks encounter.

@hwillson
Copy link
Member Author

Awesome @StephenBarlow - I'll get this merged first thing in the AM. Thanks very much!

@StephenBarlow
Copy link
Contributor

@hwillson Hold off on merging tomorrow until our esteemed colleague @trevorblades is prepared to push a complementary Netlify change roughly simultaneously. Otherwise, all of the existing 3.0-beta doc URLs out there will be broken for a time.

@hwillson hwillson force-pushed the more-ac3-docs-tweaks branch from 59e3bf2 to 69f2951 Compare July 14, 2020 16:18
@hwillson hwillson merged commit b5407a3 into master Jul 14, 2020
@hwillson hwillson deleted the more-ac3-docs-tweaks branch July 14, 2020 16:19
benjamn added a commit that referenced this pull request Feb 8, 2021
Closes #7473, if nothing breaks.

This dependency was added in bf9d073 as
part of #6429. Back then, `gatsby` and `gatsby-cli` depended on the `ink`
package, but I can't find any current usage of the `ink` package outside
of the devDependencies of those Gatsby packages, so I believe it should be
safe to remove it.
benjamn added a commit that referenced this pull request Feb 8, 2021
Closes #7473, if nothing breaks.

This dependency was added in bf9d073 as
part of #6429. Back then, `gatsby` and `gatsby-cli` depended on the `ink`
package, but I can't find any current usage of the `ink` package outside
of the devDependencies of those Gatsby packages, so I believe it should be
safe to remove it.
benjamn added a commit that referenced this pull request Feb 8, 2021
Closes #7473, if nothing breaks.

This dependency was added in bf9d073 as
part of #6429. Back then, `gatsby` and `gatsby-cli` depended on the `ink`
package, but I can't find any current usage of the `ink` package outside
of the `devDependencies` of those Gatsby packages, so I believe it should be
safe to remove it.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants