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

Adding link to flutter reference docs to top of navigation #5335

Merged
merged 212 commits into from
Apr 5, 2023

Conversation

rachelnabors
Copy link
Contributor

@rachelnabors rachelnabors commented Apr 4, 2023

Description of changes:

Adds a "flutter API references" index page to the docs that links out to all the flutter docs on pub.dev, visible only to people who have chosen Flutter as their platform, visible at docs.amplify.aws/flutter-references

image

@rachelnabors rachelnabors requested a review from a team as a code owner April 4, 2023 02:06
@aws-amplify-us-west-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-5335.d39agkzf0cwtdz.amplifyapp.com

@abdallahshaban557
Copy link
Contributor

@rachelnabors - the only thing I have noticed is that the platform picker disappears when you go to the API references page. Is that expected? Or would we want to add it there as well?

@rachelnabors
Copy link
Contributor Author

I'm guessing if you're on the flutter API page, since there is no alternative in other platforms and you're looking at Flutter docs, it isn't a very useful thing to have!

@abdallahshaban557
Copy link
Contributor

got it! approving!

Copy link
Contributor

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM

JagWireZ and others added 20 commits April 4, 2023 16:56
* fix: add bottom padding to menu so there is more room to scroll

* Decrease padding
* fix: add callout for delete mutation permissions

* fix: minor nits
* block merging 'sudo' in content

* moving sudo to flagwords

* Removing  call out from CLI installation instructions

* Add cspell comments to disable checking around sudo commands

Co-authored-by: Tim Nguyen <timngyn@gmail.com>
Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 4.2.0 to 4.2.1.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@4.2.1/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
* chore: add snapcraft.yaml example

* chore: update snapcraft example

* Update src/fragments/lib/project-setup/flutter/platform-setup/platform-setup.mdx

Co-authored-by: Dillon Nys <24740863+dnys1@users.noreply.github.com>

* chore: remove  in Amplify-Flutter

* chore: include lin kto flutter docs

* chore: add links, update libglib2

Co-authored-by: Dillon Nys <24740863+dnys1@users.noreply.github.com>
…_password_note.mdx

Co-authored-by: josef <josef.aidt@gmail.com>
* feat(cli-mock): add section for searchable mocking

* Update src/pages/cli/usage/mock.mdx

Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>

* fix: address cr comments

* chore: fix minor nit

* fix: address nits

Co-authored-by: phani-srikar <phanisrikar93ume@gmail.com>
Co-authored-by: R L Nabors <rachelnabors@users.noreply.github.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
timngyn and others added 22 commits April 4, 2023 16:58
* Add workflow to check for new files

* update codeowners link

* Add newlines

* Move var into env var

* Update workflow to pull codeowners from current branch

* Only run check if there are new files

* Split out inline github scripts into its own JS file

* Fix typos

* Don't filter out documentation-team owners

* Console log new files found before adding a comment to the PR

* Don't hardcode fetch url

* Specify version for ignore package

* Update workflow based on feedback

* Return the entire github.paginate call in order to return the file count
* fixed indent for JS/RN in Auth category

* added a couple more pages and removed the CLI commands from this PR
* Update integrate.mdx

fix (android): corrected the Datastore query update code sample

* Update integrate.mdx

Updated the delete code snippet and corrected the update code indentation.

* fixed the update logic
Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 4.4.0 to 4.4.2.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@4.4.2/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Update integrate.mdx

fix (android): corrected the Datastore query update code sample

* Update integrate.mdx

Updated the delete code snippet and corrected the update code indentation.

* fixed the update logic

* Update override.mdx

Added Opensearch override samples

#3963

* Update override.mdx

updated the spacings.

* Update override.mdx

fixed indentation

* Update override.mdx

updated based on review comments
* Update setup.mdx

Hi -

Update made for Angular 15 support.  src/polyfill.ts does not exist.  Aligning this documentation with Amplify docs - https://ui.docs.amplify.aws/angular/getting-started/troubleshooting.

Regards,
Rennay

* Update using BlockSwitcher 

Hi -

As per suggestion from @tannerabread, I have made the update using BlockSwitcher.  Apologies in advance if not completed correctly.  I could not confirm using Preview.  Please let me know if any further update required.  Again, aligning to https://ui.docs.amplify.aws/angular/getting-started/troubleshooting.

Regards,
Rennay
…ple (5257) (#5283)

* fix(data): replace broken JS example with a working React Native example (5257)

* fix(data): fix JS example typos

* address PR feedback
* standardized 'configuring you app' steps

* removed CLI prompt from indent rule
…ia CLI or existing resources (#5219)

* update docs to include switch for CLI and existing resources when adding authentication

* fix flutter page with proper "existing resources" code sample

* fix to file type and minor visual improvement of code sample

* add preamble after "Set Up Backend Resources"

* add back in the 'Identify User' title/reference in directory.js (out of scope for this PR, saving for Analytics updates overall).

* Updates to remove config/dependencies within Blockswitcher, additional PR feedback implemented.

* space added for spell check error

* New block add for 3 options (2 CLI and 1 Manual config) for Auth backend resources.

* Further refinement of blocks and verbiage. Add 3rd Manual Config block for Flutter & mobile.

* fixes to create new fragments for Flutter/iOS/Android pages

* add change to js preamble

* fixes to links that navigating to wrong platform, general feedback from PR Reviews, and added of existing AWS resource links.

* Revert callouts

* remove a comma that leads to invalid JSON string

* revert "jsx" to "dart" for code block

* Update src/fragments/lib/auth/js/getting-started.mdx

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>

* Update src/fragments/lib/auth/android/getting_started/50_configureBackend.mdx

Following new Rule #21 for indentation

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>

* Update src/fragments/lib/auth/flutter/getting_started/70_configureBackend.mdx

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>

* Update src/fragments/lib/auth/ios/getting_started/50_configureBackend.mdx

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>

* Update src/fragments/lib/auth/js/getting-started.mdx

Rule 21

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>

---------

Co-authored-by: Bannon Tanner <bannon.n.tanner@gmail.com>
* chore: add callout for granular read use case

* Update src/pages/cli/graphql/authorization-rules.mdx

Co-authored-by: David McAfee <mcafd@amazon.com>

* Update src/pages/cli/graphql/authorization-rules.mdx

---------

Co-authored-by: David McAfee <mcafd@amazon.com>
Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>
* Add platform independent script for headless init

* rename to amplify-headless-init-payload.json

* Update src/pages/cli/usage/headless.mdx

Co-authored-by: josef <josef.aidt@gmail.com>

* Update src/pages/cli/usage/headless.mdx

Co-authored-by: josef <josef.aidt@gmail.com>

* commit to re-trigger checks

* Update src/pages/cli/usage/headless.mdx

* Add newline after meta object

---------

Co-authored-by: josef <josef.aidt@gmail.com>
Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>
Co-authored-by: Tim Nguyen <timngyn@gmail.com>
Bumps [@aws-amplify/ui-react](https://github.com/aws-amplify/amplify-ui/tree/HEAD/packages/react) from 4.4.2 to 4.4.3.
- [Release notes](https://github.com/aws-amplify/amplify-ui/releases)
- [Changelog](https://github.com/aws-amplify/amplify-ui/blob/main/packages/react/CHANGELOG.md)
- [Commits](https://github.com/aws-amplify/amplify-ui/commits/@aws-amplify/ui-react@4.4.3/packages/react)

---
updated-dependencies:
- dependency-name: "@aws-amplify/ui-react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* fix(android): Fix out of order setup step

* Update 40_verifyAmplifyLibraries.mdx
Co-authored-by: Akshay Upadhyay <akz@amazon.com>
* Import default export of ExpoSQLiteAdapter

* nothing commit to trigger required checks

---------

Co-authored-by: Katie Goines <30757403+katiegoines@users.noreply.github.com>
* feat: add Amplify CLI command reference

* chore: migrate next.config, directory to ESM. enables reading cli command info from npm distribution

* chore: add amplify-cli-core as a dependency

* fix: inline code block sidenav link

* migrate away from 'tasks' cmd, mjs tasks

* jest to transform mjs

* directory import to use mjs extension, correct expected error message

* revert error message correction due to different node versions

* update lockfile

* fix subcommand descriptions, remove usage subsections

* pin amplify-cli-core version

* add types, fix usage of table captions

* patch duplicate subcommands from dataset

* update lockfile from main

* use scoped package, update to 4+
@github-advanced-security
Copy link

You have successfully added a new CodeQL configuration /language:javascript. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

Copy link
Contributor

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM

@rachelnabors rachelnabors merged commit add5386 into main Apr 5, 2023
@rachelnabors rachelnabors deleted the add-flutter-refs branch April 5, 2023 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.