Add troubleshooting for missing real-time event data #7955
Conversation
There was a problem hiding this comment.
Why is this the right location to inject this content?
Does the accordion allow us to deep link directly to this content?
Overall, I don't have any objections to this, so I'm checking approve. I wonder if there isn't a better way to get this information in front of the customers who are having the problem. I imagine we'll deep link to this from issues / stack overflow articles where folks are encountering this issue, so we want to optimize that experience, if possible.
I'm certainly open to suggestions if something else seems better. My reasoning was that it probably only applies to a subset of customers who are using real-time data, so dropping it as a troubleshooting guidance immediately after that "real-time" data section seemed fitting. Accordion content doesn't appear link-able unfortunately. But, I had intended to link to the real-time data header and refer to the "associated troubleshooting guide". 🤷 |
| @@ -81,6 +81,102 @@ export default function MyComponent() { | |||
|
|
|||
| `observeQuery` fetches and paginates through all of your available data in the cloud. While data is syncing from the cloud, snapshots will contain all of the items synced so far and an `isSynced` status of `false`. When the sync process is complete, a snapshot will be emitted with all the records in the local store and an `isSynced` status of `true`. | |||
|
|
|||
| <Accordion title='Missing real-time events and model fields' headingLevel='4' eyebrow='Troubleshooting'> | |||
There was a problem hiding this comment.
should this be heading level 3?
There was a problem hiding this comment.
You tell me! I copied another Accordion and it looked OK to me. I don't see what changing the level actually does. 😅
Description of changes:
Adds a troubleshooting accordion under the real-time data (observeQuery) section, explaining why data might appear to be "missing" from real-time updates with tips to resolve.
Related GitHub issue #, if available:
aws-amplify/amplify-js#13267
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.