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

fix(Swift): Addressing some gaps in Geo Gen2 doc pages #7573

Merged
merged 3 commits into from May 14, 2024

Conversation

ruisebas
Copy link
Member

Description of changes:

This PR addresses the following issues within the Swift Gen2 documentation for Geo:

Set up Amplify Geo
  • Removed unnecessary block for installation instructions, and rewrote them to be consistent with other platforms
  • Added explicit instruction to generate and add the amplify_outputs.json file to the project.
  • Fixed some outdated signatures being used
  • Added missing import statement to the initialization code
Work with maps
  • Removed outdated UIKit code mentioning both "Stable release" (i.e. v1) and "Developer Preview" (i.e. v2)
Configure location search
  • Added missing aws_region to the backend code snippet.
Work with location search
  • Fixed indentation in a code snippet

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
  • Swift
  • 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://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">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.

@ruisebas ruisebas requested review from hdworld11 and a team as code owners May 10, 2024 19:59
hdworld11
hdworld11 previously approved these changes May 10, 2024
hdworld11
hdworld11 previously approved these changes May 13, 2024
harsh62
harsh62 previously approved these changes May 13, 2024
Comment on lines +341 to +345
Make sure to generate the `amplify_outputs.json` file by running the following command:

```bash title="Terminal" showLineNumbers={false}
npx ampx sandbox
```
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be moved outside the swift block? I think we should keep the prose relatively the same across platforms (with a few exceptions) for maintainability and a concise UX

Copy link
Member Author

Choose a reason for hiding this comment

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

We could explore doing that in the future as a docs clean up, but right now each platform is doing its own thing

Copy link
Contributor

Choose a reason for hiding this comment

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

platform-specific callouts were (mostly) cleaned up when content was ported into this new structure. swift has the callout to move the file into the project, which is fine, but prose should be relatively the same

…up-geo/index.mdx

Co-authored-by: josef <josef.aidt@gmail.com>
@ruisebas ruisebas dismissed stale reviews from harsh62 and hdworld11 via 89e64c0 May 13, 2024 17:03
@ruisebas ruisebas merged commit 73b31e3 into main May 14, 2024
10 checks passed
@ruisebas ruisebas deleted the ruisebas/gen2_swift_geo branch May 14, 2024 13:33
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.

None yet

4 participants