Skip to content

Commit 0926392

Browse files
khatruong2009salihguelerJordan-NelsonNikaHsntylerjroach
authored
feat: Flutter V2 Gen1 Docs Update (#7499)
* chore: analytics transfer * chore: authentication transfer from current to prev * chore: API transfer v1 from current to previous * chore: Storage and functions v1 transfer from current to prev * chore: transfer push notifications v1 docs from current to prev * chore: transfer existing resources v1 from current to prev * chore: transfer datastore v1 from current to prev * [Gen 2][Bugfix] Update the flutter mobile support doc. (#7245) * Update the flutter mobile support doc. * Add file name. * Add Safe Area. * chore: change link and maintenance call out from v0 to v1 * chore: update flutter storage apis (#7326) * chore: update flutter v2 migration guide (#7327) * chore: update flutter v2 docs to use plugin options (#7336) * chore: add multi auth back to v1 previous (#7335) * StoragePath Documentation for Gen1 (#7279) * storage: update swift storage with storage path * chore: update swift storage docs with storage path * chore: update storage getting started content * chore: add callout warning to file access level * chore: update gen2 callout * chore: convert fragments to inline filter * update storage path example * Android Gen2 Storage * remove upload from getting started * Add Using Storagepath * add content to storage path page * Expand storagepath * improve doc * update callout message * modify file access level callout * add accidental remove * gramatical issues * Update src/pages/[platform]/build-a-backend/storage/download/index.mdx Co-authored-by: Jordan Nelson <[email protected]> * Update src/pages/[platform]/build-a-backend/storage/upload/index.mdx Co-authored-by: Jordan Nelson <[email protected]> * Update src/pages/[platform]/build-a-backend/storage/storagepath/index.mdx Co-authored-by: Jordan Nelson <[email protected]> * Update src/pages/[platform]/build-a-backend/storage/list/index.mdx Co-authored-by: Jordan Nelson <[email protected]> * Update src/pages/[platform]/build-a-backend/storage/remove/index.mdx Co-authored-by: Jordan Nelson <[email protected]> * Bump Android version --------- Co-authored-by: Tuan Pham <[email protected]> Co-authored-by: Jordan Nelson <[email protected]> * chore: add kotlin update to docs and formatting changes for flutter (#7023) * chore: add kotlin update to docs and formatting changes for new flutter build.gradle creation * chore: remove steps for apps created with flutter 3.16 and earlier * chore: apply suggestions from code review Co-authored-by: Muhammed Salih Guler <[email protected]> * Chore: Removed v0 flutter fragments (#7349) * chore: remove v0 flutter fragment * chore: remove move flutter fragment * chore: remove the move page from the directory and remove move from pages completely * chore: fix broken links by adding inline filters (#7356) * chore: fix broken links by adding inline filters * chore: remove the line instead of use InlineFilter since flutter is the only platform with this page * chore: remove getting started link under storage subheading that was being used as a placeholder * chore: added filter to fix broken link (#7382) * chore: remove move from directory * chore: fix gen1 v1 authentication section * chore: fixed flutter v1 gen1 docs * chore: fix v1 rest api gen 1 * chore: fix storage and functions v1 gen 1 and * chore: fix datastore v1 gen1 * chore: cleanup broken links * chore: add maintenance banner to all push notification pages * chore: add maintenance banner on all sub headings * chore: add missing maintenance banners to auth section * chore: add existing resources section * chore: remove duplicated paragraph in auth section and updated callout on remember a device * chore: fix code snippet in graphql authorization modes section * chore: fix code snippets in rest api section * chore: fix function links flutter v1 gen 1 * chore: fix storage snippets * chore: fix childnodes for best practices and existing aws resources * chore: fixed looking for legacy docs links * chore: fixed here links in configure storage * chore: fix configure amplify cli links * chore: fix tools links * chore: fix android pages * chore: update pubspec.yaml snippets to use the new version of flutter * chore: fix inline filters for swift v1 pages * chore: update storage v2 snippets to use path * chore: add storage path for flutter (#7536) * chore: remove environment section of pubspec snippets * chore: flutter v2 cleanup (#7545) * chore: address upgrade guide comments * chore: remove references to flutter version * fix: correct the sendUserAttributeConfirmationCode API name (#7547) * fix: added custom primary key migration * fix: CPK table verbiage * chore: fix typo in admin_actions name, use one header for all platforms for graphql advanced workflows, fix formatting for inline filter in existing resources * chore: remove duplicate pages that don't exist on gen2 and edit paths * Flutter v2 gen2 remove pages (#7579) * chore: remove pages ported from gen1 current to gen1 prev * chore: fix flutter v2 PN docs (#7580) * chore: refactor push notification docs * chore: remove dup notification fragments * chore: remove `/lib/` references * chore: update references to `prev` * chore: update analytics enable example * chore: remove references to min flutter version * chore: fix path typos * chore: change existing resources link to the correct page * chore: move set up cli link to current since it doesn't exist on prev * chore: add flutter back into platforms export in the under the hood and existing platform pages * chore: addressed comments regarding removing split up context between… (#7585) * chore: addressed comments regarding removing split up context between platforms, changing headers, removing unnecessary fragments * Flutter v2 gen2 comment fixes (#7598) * chore: remove callout that should be in migration guide * chore: remove unnecessary code snippet that originates from vCurrent * chore: fix incorrect references to vCurrent fragments inside vPrev pages * chore: remove unnecessary line for flutter custom challenge in both prev and current * chore: make function public in prev and current * chore: remove "suppports-only-mobile" * chore: remove unnecessary inline filters and put back an upload fragment * chore: remove unnecessary inline filter from graphql link * chore: remove unintentionally added line * chore: move flutter back to the top of the platforms list * chore: delete before you begin snippet for grapql vprev * chore: add picture back in to vprev flutter storage page * chore: revert flutter import changes back to original * chore: clean up preReq snippets * chore: add title="Terminal" showLineNumbers={false} to terminal snippets * chore: revert changes that are out of scope * chore: revert removal of inline filter and addition of white space * chore: revert changes that removed before you begin snippet * chore: revert change to wording * Apply suggestions from code review Co-authored-by: Jordan Nelson <[email protected]> * chore: revert white space changes * chore: revert bash back to console * chore: remove inline filters and add fragment back in * chore: add statement about models back in * chore: remove unused "datastore coming soon" file * chore: remove callout * chore: revert user pool capitalization changes: out of scope * chore: change the order of query data beginsWith back to original * chore: remove callouts * chore: revert spacing change * chore: fixes for auth category (#7612) * chore: flutter v2 storage fixes (#7615) * chore: add missing code snippets for storage * chore: filter out content for flutter * Update src/fragments/lib-v1/auth/native_common/user_attributes/common.mdx Co-authored-by: Jordan Nelson <[email protected]> * Flutter v2 fix analytics (#7618) * chore: add missing snippet in identify user * chore: remove flutter from javascript canonical objects * chore: delete unused fragment * chore: remove canonicalObjects that were added * chore: update a link in v1 to point to prev instead of vCurreent * chore: revert changes in mutate-data file and fix formatting * Update src/fragments/lib-v1/datastore/flutter/sync/50-selectiveSync.mdx Co-authored-by: Jordan Nelson <[email protected]> * Update src/fragments/lib-v1/storage/existing-resources.mdx Co-authored-by: Jordan Nelson <[email protected]> * chore: revert out of scope changes * chore: update storage import existing resource * chore: remove changes to js only files * chore: clean up gen 2 pre-req * chore: remove link to platform setup guide in gen 2 * chore: update pre-reqs and getting started --------- Co-authored-by: Muhammed Salih Guler <[email protected]> Co-authored-by: Jordan Nelson <[email protected]> Co-authored-by: NikaHsn <[email protected]> Co-authored-by: Tyler Roach <[email protected]> Co-authored-by: Tuan Pham <[email protected]> Co-authored-by: Elijah Quartey <[email protected]> Co-authored-by: Jordan Nelson <[email protected]>
1 parent 0978549 commit 0926392

File tree

274 files changed

+4344
-2111
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+4344
-2111
lines changed

cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1126,6 +1126,7 @@
11261126
"resolver's",
11271127
"resourcename",
11281128
"Resources.S3Bucket.Properties.BucketName",
1129+
"respectprimarykeyattributesonconnectionfield",
11291130
"RESTAPI",
11301131
"RESTENDPOINT",
11311132
"resubscription",

redirects.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10178,5 +10178,10 @@
1017810178
"source": "/gen1/react/reference/cli-commands/",
1017910179
"target": "/gen1/react/tools/cli/commands/",
1018010180
"status": "301"
10181-
}
10181+
},
10182+
{
10183+
"source": "/gen1/flutter/build-a-backend/storage/move/",
10184+
"target": "/gen1/flutter/prev/build-a-backend/storage/move/",
10185+
"status": "301"
10186+
}
1018210187
]

src/components/Breadcrumbs/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const overrides = {
2121
'/gen1/javascript/prev': 'V5',
2222
'/gen1/swift/prev': 'V1',
2323
'/gen1/android/prev': 'V1',
24-
'/gen1/flutter/prev': 'V0',
24+
'/gen1/flutter/prev': 'V1',
2525
'/gen1/react/prev': 'V5',
2626
'/gen1/react-native/prev': 'V5',
2727
'/gen1/angular/prev': 'V5',

src/constants/feature-lists-data.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,12 +266,6 @@ const featureListData = {
266266
'Upload and download files to and from cloud storage with advanced controls like pausing and resuming upload operations.',
267267
linkText: 'Upload and Download files',
268268
link: 'build-a-backend/storage/upload/'
269-
},
270-
{
271-
content:
272-
'Manage content through APIs for listing, accessing, and manipulating files. Set file permission levels, configure automatic events and triggers, and more.',
273-
linkText: 'Advanced file operations and access control',
274-
link: 'build-a-backend/storage/configure-access/'
275269
}
276270
],
277271
heading: 'Storage'

src/data/platforms.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ export const PLATFORM_VERSIONS = {
4949
current: 'v2'
5050
},
5151
flutter: {
52-
prev: 'v0',
53-
current: 'v1'
52+
prev: 'v1',
53+
current: 'v2'
5454
},
5555
javascript: {
5656
prev: 'v5',

src/directory/directory.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1284,9 +1284,6 @@ export const directory = {
12841284
{
12851285
path: 'src/pages/gen1/[platform]/build-a-backend/storage/copy/index.mdx'
12861286
},
1287-
{
1288-
path: 'src/pages/gen1/[platform]/build-a-backend/storage/move/index.mdx'
1289-
},
12901287
{
12911288
path: 'src/pages/gen1/[platform]/build-a-backend/storage/remove/index.mdx'
12921289
},
@@ -2362,6 +2359,9 @@ export const directory = {
23622359
{
23632360
path: 'src/pages/gen1/[platform]/prev/build-a-backend/storage/copy/index.mdx'
23642361
},
2362+
{
2363+
path: 'src/pages/gen1/[platform]/prev/build-a-backend/storage/move/index.mdx'
2364+
},
23652365
{
23662366
path: 'src/pages/gen1/[platform]/prev/build-a-backend/storage/remove/index.mdx'
23672367
},
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
- [Install and configure Amplify CLI](/gen1/[platform]/tools/cli/start/set-up-cli/)
2-
- A Flutter application targeting Flutter SDK >= 2.10.0 (stable version) with Amplify libraries integrated
3-
- An iOS configuration targeting at least iOS 11.0
4-
- An Android configuration targeting at least Android API level 21 (Android 5.0) or above
5-
- For a full example please follow the [project setup walkthrough](/gen1/[platform]/prev/start/project-setup/create-application/)
1+
* [Install and configure Amplify CLI](/gen1/[platform]/tools/cli/start/set-up-cli/)
2+
3+
Amplify Flutter requires a minimum target platform for iOS (13.0), Android (API level 24), and macOS (10.15). Additional setup is required for some target platforms. Please see the [platform setup](/gen1/[platform]/prev/start/project-setup/platform-setup/) guide for more details on platform specific setup.

src/fragments/lib-v1/analytics/flutter/getting-started/20_installLib.mdx

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,8 @@ In your Flutter project directory, open **pubspec.yaml**.
55
Add Analytics by adding these libraries into your dependencies block:
66

77
```yaml
8-
environment:
9-
sdk: '>=2.15.0 <3.0.0'
10-
118
dependencies:
12-
# Should already be added during Project Setup walkthrough
13-
amplify_flutter: ^0.6.0
14-
15-
# Add these lines in `dependencies` if you have not added it earlier during the Project Setup
16-
amplify_auth_cognito: ^0.6.0
17-
amplify_analytics_pinpoint: ^0.6.0
9+
amplify_analytics_pinpoint: ^1.0.0
10+
amplify_auth_cognito: ^1.0.0
11+
amplify_flutter: ^1.0.0
1812
```

src/fragments/lib-v1/analytics/flutter/getting-started/30_initAnalytics.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Future<void> _configureAmplify() async {
1616
}
1717
```
1818

19+
<Callout>
20+
21+
When running your app on macOS you will need to enable keychain sharing in Xcode, as described in the [Project setup guide](/gen1/[platform]/prev/start/project-setup/platform-setup/#enable-keychain).
22+
23+
</Callout>
24+
1925
Make sure that the `amplifyconfiguration.dart` file generated in the project setup is included and sent to `Amplify.configure`:
2026

2127
```dart

src/fragments/lib-v1/analytics/flutter/getting-started/40_record.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To record an event, create an `AnalyticsEvent` and call `Amplify.Analytics.recor
66
Future<void> trackEventsWithProperties() async {
77
final event = AnalyticsEvent('test');
88
9-
event.properties
9+
event.customProperties
1010
..addBoolProperty('boolKey', true)
1111
..addDoubleProperty('doubleKey', 10)
1212
..addIntProperty('intKey', 10)

0 commit comments

Comments
 (0)