-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Author your own plugin tutorial & CLI intialization/configuration doc #10
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
Conversation
| The AWS Amplify CLI helps you set up an AWS IAM user, set up an AWS profile on your local system and the initialize Amplify powered apps with all your defined configurations. We'll also walk through steps as to how you could share the Amplify generated backend configuration between other frontend projects and re-use the same backend infrastructure in-between multiple platforms/users. | ||
|
|
||
| In this tutorial, we'll go walk through setting up an Amplify enabled project and go in detail as to what happens behind the scenes when doing so. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a TOC here with hyperlinks to the 3 areas? You just need to use a Title format.
init_configure_commands_tut.md
Outdated
| ```bash | ||
| $ amplify configure | ||
| ``` | ||
| The `amplify configure` command is a one-time setup step which helps you with the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would change to this: "The amplify configure command is a one-time setup step. After you perform this on your system you only need to run amplify init going forward on new projects. If you already have the AWS CLI configured on your system you can usually skip this step. The amplify configure step helps you with the following:"
init_configure_commands_tut.md
Outdated
| $ amplify init | ||
| ``` | ||
|
|
||
| The amplify init command is a one-time setup step for your Amplify powered cloud app which helps you with the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would change to this: "The amplify init command is a one-time initialization step for your Amplify powered cloud app. You run this once for each project (JavaScript, iOS, or Android) to connect your app with an AWS backend. This setup helps you with the following:"
init_configure_commands_tut.md
Outdated
| ```bash | ||
| $ amplify configure project | ||
| ``` | ||
| The `amplify configure project` command should be used in the following cases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would change to: "The amplify configure project is an advanced command and not commonly used for getting started or individual development projects. The command should be used in the following cases:"
undefobj
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments for the commands doc. The other one looks good to go.
|
@undefobj Thanks for the feedback. Updated the doc with your changes. I don't have permissions to merge. @mlabieniec Please merge if you think its ready to be merged. |
mlabieniec
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you update the file names:
cli/init.md
cli/plugins.md
``` E/flutter (30435): [ERROR:flutter/lib/ui/ui_dart_state.cc(177)] Unhandled Exception: type '_InternalLinkedHashMap<String, dynamic>' is not a subtype of type 'Map<String, String>' E/flutter (30435): #0 new CognitoSignUpOptions (package:amplify_auth_cognito/src/CognitoSignUp/CognitoSignUpOptions.dart:20:87) E/flutter (30435): #1 SignUpState._signUp (package:AwsAmplifySample/components/signUp.dart:29:20) E/flutter (30435): #2 SignUpState.build.<anonymous closure> (package:AwsAmplifySample/components/signUp.dart:190:35) E/flutter (30435): #3 _InkResponseState._handleTap (package:flutter/src/material/ink_well.dart:993:19) E/flutter (30435): #4 _InkResponseState.build.<anonymous closure> (package:flutter/src/material/ink_well.dart:1111:38) E/flutter (30435): #5 GestureRecognizer.invokeCallback (package:flutter/src/gestures/recognizer.dart:183:24) E/flutter (30435): #6 TapGestureRecognizer.handleTapUp (package:flutter/src/gestures/tap.dart:598:11) E/flutter (30435): #7 BaseTapGestureRecognizer._checkUp (package:flutter/src/gestures/tap.dart:287:5) E/flutter (30435): #8 BaseTapGestureRecognizer.acceptGesture (package:flutter/src/gestures/tap.dart:259:7) E/flutter (30435): #9 GestureArenaManager.sweep (package:flutter/src/gestures/arena.dart:157:27) E/flutter (30435): #10 GestureBinding.handleEvent (package:flutter/src/gestures/binding.dart:362:20) E/flutter (30435): #11 GestureBinding.dispatchEvent (package:flutter/src/gestures/binding.dart:338:22) E/flutter (30435): #12 RendererBinding.dispatchEvent (package:flutter/src/rendering/binding.dart:267:11) E/flutter (30435): #13 GestureBinding._handlePointerEvent (package:flutter/src/gestures/binding.dart:295:7) E/flutter (30435): #14 GestureBinding._flushPointerEventQueue (package:flutter/src/gestures/binding.dart:240:7) E/flutter (30435): #15 GestureBinding._handlePointerDataPacket (package:flutter/src/gestures/binding.dart:213:7) E/flutter (30435): #16 _rootRunUnary (dart:async/zone.dart:1206:13) E/flutter (30435): #17 _CustomZone.runUnary (dart:async/zone.dart:1100:19) E/flutter (30435): #18 _CustomZone.runUnaryGuarded (dart:async/zone.dart:1005:7) E/flutter (30435): #19 _invoke1 (dart:ui/hooks.dart:265:10) E/flutter (30435): #20 _dispatchPointerDataPacket (dart:ui/hooks.dart:174:5) E/flutter (30435): ``` If `dynamic` is used
No description provided.