aws-amplify / aws-amplify/docs
[Feedback] Geo: many references to aws-export.js but no examples
- Dominant language
- MDX
- Stars
- 506
- Forks
- 1.1k
- Avg merge
- 3h 14m
- Merged PRs (30d)
- 1
Description
**Page**: [`/lib/geo/maps/q/platform/[platform]`](docs.amplify.aws/lib/geo/maps/q/platform/js/#add-map-to-html-website)
**Feedback**:
While going through the instructions for using Amplify Geo with an HTML website, it includes `import awsconfig from "./aws-exports.js";`, but does not show (or link) what this file should contain. I'm adapting an existing sample and have already created an identity pool and Map resource that I intend to re-use.
https://docs.amplify.aws/lib/geo/existing-resources/q/platform/js/#in-your-application comes close, but this is not the exportable form.
Contributor guide
Research direction
Start at docs.amplify.aws/lib/geo/maps/q/platform/js/#add-map-to-html-website and review the existing-resources page linked in the feedback. Determine what exportable aws-exports.js form an HTML website user needs, then add an example or link that shows its contents. Done means the referenced import is understandable without guessing what the file contains.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100