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

Updated gen2 docs and updated import paths #6260

Merged
merged 14 commits into from
Nov 9, 2023

Conversation

renebrandel
Copy link
Contributor

Description of changes:

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • iOS
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://link.com)
    HTML: <a href="https://link.com">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@renebrandel renebrandel requested review from a team and abdallahshaban557 as code owners November 9, 2023 00:22
elorzafe
elorzafe previously approved these changes Nov 9, 2023
Copy link
Contributor

@elorzafe elorzafe 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 auth part

Copy link
Contributor

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@heatheramz heatheramz left a comment

Choose a reason for hiding this comment

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

@renebrandel just a heads up that links can be updated and one other nit for the the directory

path: 'src/pages/gen2/build-a-backend/data/offline/index.mdx'
}
path: 'src/pages/gen2/build-a-backend/data/migration/index.mdx'
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
},
}

- GraphQL APIs hosted using API Gateway
Before you begin, you will need:
- your cloud sandbox with an Amplify Data resource up and running (`npx amplify sandbox`)
- A frontend application set up. For instructions on setting up an app, see [Project Setup: Create your application](https://docs.amplify.aws/lib/project-setup/create-application/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

@renebrandel general comment that links on this page should be updated to new pages - would project set up here go to a Gen2 get started?

## Next steps

Our recommended next steps include using the API to mutate and query data. You can also review how to subscribe to real-time events to look for mutations in your data. Some resources that will help with this work include:
- [Create, update, and delete application data](/lib/graphqlapi/mutate-data/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

These should be updated to Gen2 links


### Use with Amplify Data
You can get a client using the defined schema and get type-safe CRUDL operations to talk to your backend database in your Node.js app.
- An [application connected to the API](/lib/graphqlapi/connect/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Update to Gen2 link


Our recommended next steps include using the API to query data and subscribe to real-time events to look for mutations in your data. Some resources that will help with this work include:

- [Read application data](/lib/graphqlapi/query-data/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Again flag for updating links to Gen 2


Before you begin, you will need:

- An [application connected to the API](/lib/graphqlapi/connect/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

link update

## Next steps

Our recommended next steps include subscribing to real-time events to look for mutations in your data and continuing to build out and customize your information architecture for your data. Some resources that will help with this work include:

Copy link
Contributor

Choose a reason for hiding this comment

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

link update

Before you begin, you will need:


- An [application connected to the API](/lib/graphqlapi/connect/q/platform/js/)
Copy link
Contributor

Choose a reason for hiding this comment

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

link update

## Next steps

Our recommended next steps include continuing to build out and customize your information architecture for your data. Some resources that will help with this work include:

Copy link
Contributor

Choose a reason for hiding this comment

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

link update

'swift',
'vue'
]
title: 'Set up Amplify GraphQL API',
Copy link
Contributor

Choose a reason for hiding this comment

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

@renebrandel The above platforms would need to be listed if you want those visiting react etc to see the JS content

@heatheramz heatheramz self-requested a review November 9, 2023 23:02
Copy link
Contributor

@heatheramz heatheramz left a comment

Choose a reason for hiding this comment

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

Per our slack convo we'll follow up on links later

Copy link
Contributor

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM

@renebrandel renebrandel merged commit 55df006 into next-release/main Nov 9, 2023
7 checks passed
@renebrandel renebrandel deleted the renbran/next-gen2-data branch November 9, 2023 23:10
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.

4 participants