Merge pull request #733 from mbahar/master

Added docs pages for front-end support
aws-amplify · Apr 25, 2018 · 9c04a31 · 9c04a31
2 parents e772a9d + 51ff8b8
commit 9c04a31
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 20 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -194,6 +194,10 @@ category_list:
     -  category: Front-end Support
        title: Front-end Support
        subs:
+        - title: Angular 
+          excerpt: Angular support package.
+          cta: Read more
+          url: '/media/angular_guide' 
         - title: React 
           excerpt: React support package.
           cta: Read more
@@ -202,10 +206,10 @@ category_list:
           excerpt: React Native support package.
           cta: Read more
           url: '/media/react_native_guide' 
-        - title: Angular 
-          excerpt: Angular support package.
+        - title: Vue.js
+          excerpt: Vue.j support package.
           cta: Read more
-          url: '/media/angular_guide' 
+          url: '/media/vuejs_guide' 
     -  category: CLI
        title: CLI
        subs:

diff --git a/docs/amplify-theme/_sass/_variables.scss b/docs/amplify-theme/_sass/_variables.scss
@@ -50,8 +50,8 @@ $color-theme-red: #FFECE6 !default;
 $color-theme-yellow: #FCFDE8 !default;
 
 /* ----- Font families ----- */
-$font-family-primary: '"Amazon Ember",Arial,sans-serif', sans-serif !default;
-$font-family-secondary: '"Amazon Ember",Arial,sans-serif', sans-serif !default;
+$font-family-primary: 'Amazon Ember,Arial,sans-serif', sans-serif !default;
+$font-family-secondary: 'Amazon Ember,Arial,sans-serif', sans-serif !default;
 $font-family-monospace: 'Source Code Pro', monospace !default;
 
 /* ----- Font sizes ----- */

diff --git a/docs/index.md b/docs/index.md
@@ -17,23 +17,20 @@ marketing_grid:
     - title: Declarative API
       excerpt: <p>AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations.</p>
                <p>
-                    See our <a href='/aws-amplify/media/examples'>code examples</a> to learn how you can 'cloud-enable' your app in under 5 minutes.
+                  See our <a href='/aws-amplify/media/examples'>code examples</a> to learn how you can 'cloud-enable' your app in under 5 minutes.
                 </p> 
     - title: Bring your own frontend 
       excerpt: <p>AWS Amplify goes well with any JavaScript based frontend workflow, and React Native for mobile developers.</p> 
-               <p>See our starter kits for  
-                  <a href='https://github.com/awslabs/aws-mobile-react-sample'>React</a>, 
-                  <a href='https://github.com/ionic-team/starters/tree/master/ionic-angular/official/aws'>Ionic</a>,
-                  <a href='https://github.com/aws-samples/aws-amplify-vue'>Vue</a>,
-                   and 
-                  <a href='https://github.com/awslabs/aws-mobile-react-native-starter'>React Native</a>.
-                   <u>Angular</u> is coming soon...   
-
+               <p>Learn more about our frontend support for
+                  <a href='/aws-amplify/media/angular_guide'>Angular</a>,
+                  <a href='/aws-amplify/media/react_guide'>React</a>, 
+                  <a href='/aws-amplify/media/react_native_guide'>React Native</a>,
+                  <a href='/aws-amplify/media/ionic_guide'>Ionic</a>,
+                  <a href='/aws-amplify/media/vuejs_guide'>Vue.js</a>
                 </p>
     - title: Open and Pluggable
       excerpt: Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service.
 
-
 # Grid navigation
 grid_navigation:
     - title: Installation

diff --git a/docs/media/api_guide.md b/docs/media/api_guide.md
@@ -444,7 +444,7 @@ const GetEvent = `query GetEvent($id: ID! $nextToken: String) {
 }`;
 
 // Simple query
-const allEvents = await API.graphql({ ListEvents });
+const allEvents = await API.graphql(graphqlOperation(ListEvents));
 
 // Query using a parameter
 const oneEvent = await API.graphql(graphqlOperation(GetEvent, { id: 'some id' }));
@@ -474,7 +474,7 @@ const eventDetails = {
     name: 'Party tonight!',
     when: '8:00pm',
     where: 'Ballroom',
-    decription: 'Coming together as a team!'
+    description: 'Coming together as a team!'
 };
 
 const newEvent = await API.graphql(graphqlOperation(CreateEvent, eventDetails));

diff --git a/docs/media/authentication_guide.md b/docs/media/authentication_guide.md
@@ -83,7 +83,10 @@ Auth.signIn(username, password)
     .then(user => console.log(user))
     .catch(err => console.log(err));
 
-// If MFA enabled, keep the user object from sign in, collect confirmation code, and then
+// If MFA is enabled, confirm user signing 
+// `user` : Return object from Auth.signIn()
+// `code` : Confirmation code  
+// `mfaType` : MFA Type e.g. SMS, TOTP.
 Auth.confirmSignIn(user, code, mfaType)
     .then(data => console.log(data))
     .catch(err => console.log(err));

diff --git a/docs/media/ionic_guide.md b/docs/media/ionic_guide.md
@@ -0,0 +1,10 @@
+---
+---
+
+# Ionic
+
+To help you start working with AWS Amplify, Ionic team provides a Starter App. See our [Ionic Starter App in Github](https://github.com/ionic-team/starters/tree/master/ionic-angular/official/aws).
+
+We will soon support Ionic components for AWS Amplify.
+{: .callout .callout--info}
+
diff --git a/docs/media/react_guide.md b/docs/media/react_guide.md
@@ -3,7 +3,9 @@
 
 # React
 
-AWS Amplify provides React Components with `aws-amplify-react` npm package.
+AWS Amplify provides React Components with `aws-amplify-react` npm package. Also, to help you start working with AWS Amplify, we provide a Starter App. 
+
+See our [React Starter App in Github](https://github.com/awslabs/aws-mobile-react-sample).
 
 ## Installation and Configuration
 

diff --git a/docs/media/react_native_guide.md b/docs/media/react_native_guide.md
@@ -3,7 +3,9 @@
 
 # React Native
 
-AWS Amplify provides React Native Components with `aws-amplify-react-native` npm package.
+AWS Amplify provides React Native Components with `aws-amplify-react-native` npm package. Also, to help you start working with AWS Amplify, we provide a Starter App. 
+
+See our [React Native Starter App in Github](https://github.com/awslabs/aws-mobile-react-native-starter).
 
 ## Installation and Configuration
 

diff --git a/docs/media/vuejs_guide.md b/docs/media/vuejs_guide.md
@@ -0,0 +1,10 @@
+---
+---
+
+# Vue.js
+
+To help you start working with AWS Amplify, we provide a Starter App. See our [Vue.js Starter App in Github](https://github.com/aws-samples/aws-amplify-vue).
+
+We will soon support Vue.js components for AWS Amplify.
+{: .callout .callout--info}
+