Skip to content

Docs update migration guide 784 #786

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

Merged
merged 7 commits into from
Nov 28, 2022
Merged

Conversation

JuLeeAtPlanet
Copy link
Contributor

@JuLeeAtPlanet JuLeeAtPlanet commented Nov 21, 2022

Related Issue(s):

Closes #784

Proposed Changes:

For inclusion in changelog (if applicable):

n/a

Not intended for changelog:

  1. Documentation now includes upgrading from v1 to v1

Diff of User Interface

n/a

PR Checklist:

  • This PR is as small and focused as possible
  • [] If this PR includes proposed changes for inclusion in the changelog, the title of this PR summarizes those changes and is ready for inclusion in the Changelog.
  • [] I have updated docstrings for function changes and docs in the 'docs' folder for user interface / behavior changes
  • This PR does not break any examples or I have updated them

(Optional) @mentions for Notifications:
@cholmes

Copy link
Contributor

@jreiberkyle jreiberkyle left a comment

Choose a reason for hiding this comment

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

looks amazing Julee! Suggested a few changes to reflect the current api

Copy link
Member

@cholmes cholmes left a comment

Choose a reason for hiding this comment

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

Looks good! There are a few things I'd consider adding, but all of them could come later, so marking this as approved so we can get this in. Happy to help ticket my suggestions if they sound good and we'd do them later.

  • Advantages of upgrading - would be good to somewhere articulate what you 'gain' from upgrading, why this is a win. Particularly the bulk requests you can do with async, and the great traffic shaping to maximally utilize our API's. I think @jreiberkyle is planning a blog post on this, so we could just link out to that from here. Or could try to explain in a line or two.
  • Additional functionality - this is related to the above, but potentially slightly different. One big one is support for Subscriptions API. We probably should also mention that basemaps and analytics aren't yet supported, so we don't have an 'upgrade path' for those and recommend sticking with v1. But I'm also wondering if we have like nicer helper functions? And like orders says 'orders api capabilities in v1 were quite primitive' - we could explain more of what v2 can help with, that are beyond 'primitive'.
  • Links to more async info. Perhaps we even work towards a dedicated section somewhere on async, since we know it's the trickiest aspect. Where we link to some relevant tutorials on async in general, and also link to our examples. We could at least link to the few examples / notebooks we have that show a few different async examples.

Again, this more than satisfies the core need to point people on v1 at a clear upgrade guide, and these are all 'nice to have', and may well better belong in other documents.

JuLeeAtPlanet and others added 3 commits November 28, 2022 14:51
Co-authored-by: Jennifer Reiber Kyle <jreiberkyle@users.noreply.github.com>
Co-authored-by: Jennifer Reiber Kyle <jreiberkyle@users.noreply.github.com>
Co-authored-by: Jennifer Reiber Kyle <jreiberkyle@users.noreply.github.com>
@JuLeeAtPlanet JuLeeAtPlanet merged commit 6033a98 into main Nov 28, 2022
@JuLeeAtPlanet JuLeeAtPlanet deleted the docs-update_migration_guide_784 branch December 1, 2022 03:46
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.

Create a migration guide to explain how to move from V1 to V2
3 participants