Android AppSync Extension Library Documentation Improvements #8217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattcreaser
reviewed
Jan 24, 2025
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/[platform]/build-a-backend/data/aws-appsync-apollo-extensions/index.mdx
Outdated
Show resolved
Hide resolved
…xtensions/index.mdx Co-authored-by: Matt Creaser <mattcreaser@gmail.com>
|
PR comments addressed |
mattcreaser
approved these changes
Jan 24, 2025
josefaidt
reviewed
Jan 25, 2025
| @@ -223,15 +203,145 @@ val authorizer = IamAuthorizer { | |||
| //highlight-end | |||
| ``` | |||
|
|
|||
| </Block> | |||
|
|
|||
| <Block name="Without Amplify"> | |||
There was a problem hiding this comment.
I hesitate with putting prose like this inside the block switcher for a few reasons:
- it makes linking to specific content difficult
- nesting headings messes with the document structure -- do they render okay in the TOC?
- since there are multiple instances of the blockswitcher and they do not sync on the page it can make reading this doc "without amplify" a bit tedious
We can modify the component to fix 3, but I have concerns with 2 if the heading structure is different between the two blocks
josefaidt
reviewed
Jan 25, 2025
|
|
||
| ### Manual | ||
| 1. Navigate to the **Queries** tab in your API on the [AWS AppSync console](https://console.aws.amazon.com/appsync/home). Here, you can test queries, mutations, and subscriptions in the GraphQL playground. | ||
| 2. Enter your GraphQL operation (query, mutation, or subscription) in the editor and click **Run** to execute it. |
There was a problem hiding this comment.
Suggested change
| 2. Enter your GraphQL operation (query, mutation, or subscription) in the editor and click **Run** to execute it. | |
| 2. Enter your GraphQL operation (query, mutation, or subscription) in the editor and select **Run** to execute it. |
nit "click" -> "select"
https://github.com/aws-amplify/docs/blob/main/STYLEGUIDE.md#15-use-carets-to-help-users-navigate-menus-use-select-instead-of-click
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Restructured the Android AppSync extension library for usage with Amplify Data or AppSync directly
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)?
Which platform(s) are affected by this PR (if applicable)?
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://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.