Skip to content

docs: Appsync Events #117

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Jul 31, 2025
Merged

docs: Appsync Events #117

merged 9 commits into from
Jul 31, 2025

Conversation

cloutierMat
Copy link
Contributor

@cloutierMat cloutierMat commented Jul 14, 2025 •
edited
Loading

This pr introduces AppSync Events API documentation. As we are sharing the page with AppSync GraphQL APIs, some restructure is also added in the pr to help keeping a clear and understandable view of the docs

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jul 14, 2025 •
edited
Loading

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9a20715
Status: ✅  Deploy successful!
Preview URL: https://f0fc8110.localstack-docs.pages.dev
Branch Preview URL: https://appsync-event-docs.localstack-docs.pages.dev

View logs

quetzalliwrites
quetzalliwrites reviewed Jul 14, 2025
View reviewed changes
@quetzalliwrites quetzalliwrites self-assigned this Jul 15, 2025
@quetzalliwrites quetzalliwrites added documentation Improvements or additions to documentation aws release-bound labels Jul 30, 2025
@quetzalliwrites quetzalliwrites marked this pull request as ready for review July 30, 2025 18:02
@quetzalliwrites quetzalliwrites changed the title Appsync event docs docs: Appsync Events Jul 30, 2025
@quetzalliwrites quetzalliwrites self-requested a review July 30, 2025 18:48
@quetzalliwrites
Copy link
Collaborator

quetzalliwrites commented Jul 30, 2025 •
edited
Loading

1. I think it's a better user experience to have the 2 ways to get started as subsections to one main Getting Started section.

Screenshot 2025-07-30 at 8 50 48 PM

2. For improved readability, I've numbered the items you need to do for each getting started option, like so:

Screenshot 2025-07-30 at 8 56 43 PM

@quetzalliwrites
Copy link
Collaborator

Preview latest draft here:
https://a86ebde1.localstack-docs.pages.dev/aws/services/appsync/

cc @cloutierMat

cloutierMat
cloutierMat commented Jul 30, 2025
View reviewed changes
cloutierMat
cloutierMat commented Jul 30, 2025
View reviewed changes
Copy link
Contributor Author

@cloutierMat cloutierMat left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the structure update. I was trying to avoid going 4 "#" deep as we lose it in the TOC... but it might be unavoidable....

Going trough the order, I understand that you are trying to avoid 2 "Getting Started", but I feel it might be necessary since right now the docs jump from GraphQL to Events and back multiple times, and that also seems confusing.

What do you think of the following order?

  • Introduction
  • GraqhQL API
    • Getting Started
    • Resolvers
    • Configuring Endpoints
    • Resource Browser
    • Example
  • Events API
    • Getting Started
    • Code Handlers
    • Configuring Endpoints
    • Resource Browser
  • Shared configurations
    • Custom API IDs
    • Data Sources
  • Evaluation Endpoints
  • API Coverage

In time we can add more information to Events API with example and some extra details. Since both APIs are solving a different problems for different users, I think that having the docs grouped by APIs will be more beneficial.

curious to hear @simonrw's opinion as well

quetzalliwrites and others added 2 commits July 31, 2025 02:03
@quetzalliwrites @cloutierMat
update vtl template name for consistency
2990a8d 
Co-authored-by: Mathieu Cloutier <79954947+cloutierMat@users.noreply.github.com>
@quetzalliwrites @cloutierMat
fix link
a2ba51d 
Co-authored-by: Mathieu Cloutier <79954947+cloutierMat@users.noreply.github.com>
@quetzalliwrites
Copy link
Collaborator

Going trough the order, I understand that you are trying to avoid 2 "Getting Started", but I feel it might be necessary since right now the docs jump from GraphQL to Events and back multiple times, and that also seems confusing.

tyvm for your detailed feedback & outline suggestion, @cloutierMat (cc @simonrw)... i'll proceed to update this PR w/ your recommended outline

@quetzalliwrites quetzalliwrites merged commit d7db8c2 into main Jul 31, 2025
1 check passed
@quetzalliwrites quetzalliwrites deleted the appsync-event-docs branch July 31, 2025 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@quetzalliwrites quetzalliwrites quetzalliwrites approved these changes

@simonrw simonrw Awaiting requested review from simonrw simonrw is a code owner

@HarshCasper HarshCasper Awaiting requested review from HarshCasper HarshCasper is a code owner

Assignees

@quetzalliwrites quetzalliwrites

Labels
aws documentation Improvements or additions to documentation release-bound
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cloutierMat @quetzalliwrites