Skip to content

Commit

Permalink
docs update (#1492)
Browse files Browse the repository at this point in the history 
* adding docs folder

* docs update
  • Loading branch information
@tommypraeger @mlabieniec
tommypraeger authored and mlabieniec committed Aug 23, 2018
1 parent e6913ee commit f519ff6
Show file tree
Hide file tree
Showing 310 changed files with 7,914 additions and 2,651 deletions.
209 changes: 152 additions & 57 deletions docs/_config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,25 +58,27 @@ future: true

# Amplify theme settings
amplify:
baseurl: /amplify-js # Since the site is deployed under https://aws-amplify.github.io/amplify-js
baseurl: # Since the site is deployed under https://aws-amplify.github.io/amplify-js
docs_baseurl: /amplify-js
color_theme: # Available themes: blue (default), green, purple, red and yellow
header:
logo:
text: AWS Amplify
image: true
platform: for JavaScript
nav:
- item_name: Quick Start
item_url: '/media/quick_start'
- item_name: Docs
item_url: '/media/developer_guide'
- item_name: Tutorials
item_url: '/media/tutorials'
- item_name: API
item_url: '/api/'
- item_name:
item_icon: github
item_external_url: 'https://github.com/aws-amplify/amplify-js'
- item_name: Get Started
item_url: '/media/get_started'
id: get_started
- item_name: Toolchain
item_url: '/media/toolchain'
id: toolchain
- item_name: Style Guide
item_url: '/media/ui_library'
id: ui_library
#- item_name:
# item_icon: github
# item_external_url: 'https://github.com/aws-amplify/amplify-js'
footer:
content:
logo:
Expand All @@ -86,10 +88,10 @@ amplify:
social_list:
- network_name: gitter
profile_url: 'https://gitter.im/AWS-Amplify/Lobby/'
- network_name: twitter
profile_url: 'https://twitter.com/search?q=%23awsamplify&src=typd'
- network_name: github
profile_url: 'https://github.com/aws-amplify/amplify-js'
- network_name: twitter
profile_url: 'https://twitter.com/search?q=%23awsamplify&src=typd'
- network_name: youtube
profile_url: 'https://www.youtube.com/watch?v=vAjf3lyjf8c'

Expand All @@ -110,14 +112,64 @@ exclude: [ 'README.md', 'CHANGELOG.md' ]
permalink: /:title

category_list:
- category: CloudFeatures
title: Cloud Features
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: 'quick_start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/media/quick_start'
icon: '/images/icons/Misc/Present.svg'
# - category: Tutorials
# title: Tutorials
# excerpt:
# base_url: 'building-web-apps'
# subs:
# - title: Web Apps
# excerpt: 'A step-by-step tutorial for learning how to build a cloud-enabled React Web app with AWS Amplify.<br/><b>30 min to complete</b>'
# url: '/media/building-web-apps'
# icon: '/images/icons/Misc/Present.svg'
# - title: React Native Apps
# excerpt: 'A step-by-step tutorial for learning how to build a cloud-enabled mobile app with React Native and AWS Amplify.<br/><b>30 min to complete</b>'
# url: '/media/building-react-native-apps'
# icon: '/images/icons/Misc/Present.svg'
# - title: Ionic 4 Apps
# excerpt: "Learn to build a cloud enabled 'Notes App' with Ionic 4 and AWS Amplify <br/><b>45 min to complete</b>"
# url: '/media/building-ionic-4-apps'
# icon: '/images/icons/Misc/Present.svg'
- category: Tutorials
title: Tutorials
excerpt:
base_url: 'react_guide'
subs:
- title: React
excerpt: #'A step-by-step tutorial for learning how to build a cloud-enabled React Web app with AWS Amplify.<br/><b>30 min to complete</b>'
url: '/media/react_guide'
icon: '/images/icons/Misc/Present.svg'
- title: React Native
excerpt: #'A step-by-step tutorial for learning how to build a cloud-enabled mobile app with React Native and AWS Amplify.<br/><b>30 min to complete</b>'
url: '/media/react_native_guide'
icon: '/images/icons/Misc/Present.svg'
- title: Angular
excerpt: #"Learn to build a cloud enabled 'Notes App' with Ionic 4 and AWS Amplify <br/><b>45 min to complete</b>"
url: '/media/angular_guide'
icon: '/images/icons/Misc/Present.svg'
- title: Ionic
excerpt: #"Learn to build a cloud enabled 'Notes App' with Ionic 4 and AWS Amplify <br/><b>45 min to complete</b>"
url: '/media/ionic_guide'
icon: '/images/icons/Misc/Present.svg'
- category: Categories
title: Categories
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/media/analytics_guide'
subs:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/media/analytics_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
Expand All @@ -129,7 +181,8 @@ category_list:
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/media/api_guide'
url: '/media/api_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
Expand All @@ -140,26 +193,20 @@ category_list:
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/media/authentication_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: Hosting
excerpt: Deploy your Web app or static website for global CDN distribution with media streaming support.
cta: Read more
class: aws-icon-ps-60-network-nodes
url: '/media/hosting_guide'
services:
- title: Amazon CloudFront
url: https://aws.amazon.com/cloudfront/
- title: Interactions
excerpt: Create conversational bots powered by deep learning technologies.
cta: Read more
class: aws-icon-ps-60-bubble-gear
url: '/media/interactions_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Lex
url: https://aws.amazon.com/lex/
Expand All @@ -168,6 +215,7 @@ category_list:
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/media/pub_sub_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS IoT,
url: https://aws.amazon.com/iot/
Expand All @@ -180,6 +228,7 @@ category_list:
cta: Read more
class: aws-icon-ps-60-device-message
url: '/media/push_notifications_setup'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint
url: https://aws.amazon.com/pinpoint/
Expand All @@ -188,66 +237,112 @@ category_list:
cta: Read more
class: aws-icon-ps-60-file-box
url: '/media/storage_guide'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- category: UtilityModules
title: Utility Modules
subs:
- category: Utilities
title: Utilities
excerpt: Common programming utilities that you can use with your app.
base_url: '/media/cache_guide'
subs:
- title: Cache
excerpt: A generic LRU cache for storing data with priority and expiration settings.
cta: Read more
url: '/media/cache_guide'
icon: '/images/icons/Misc/Gear.svg'
- title: Hub
excerpt: A lightweight local event bus for your app.
cta: Read more
url: '/media/hub_guide'
icon: '/images/icons/Misc/Gear.svg'
- title: I18n
excerpt: A lightweight internationalization solution.
cta: Read more
url: '/media/i18n_guide'
icon: '/images/icons/Misc/Gear.svg'
- title: Logger
excerpt: Console logging utility.
cta: Read more
url: '/media/logger_guide'
icon: '/images/icons/Misc/Gear.svg'
- title: Service Worker
excerpt: A utility class to work with PWA and Service Worker APIs.
cta: Read more
url: '/media/service_workers_guide'
- category: CLI
title: CLI
subs:
- title: AWS Mobile CLI
excerpt: A CLI to create and manage your app's backend.
cta: Read more
url: '/media/cli_guide'
- category: Front-end Support
title: Front-end Support
subs:
- title: Angular
excerpt: Angular support package.
cta: Read more
url: '/media/angular_guide'
- title: Ionic
excerpt: Ionic starter app and component support.
cta: Read more
url: '/media/ionic_guide'
- title: React
excerpt: React support package.
cta: Read more
url: '/media/react_guide'
- title: React Native
excerpt: React Native support package.
url: '/media/service_workers_guide'
icon: '/images/icons/Misc/Gear.svg'

- category: Toolchain
title: Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/media/cli_guide'
subs:
- title: Hosting
excerpt: Deploy your Web app or static website for global CDN distribution with media streaming support.
cta: Read more
url: '/media/react_native_guide'
- title: Vue.js
excerpt: Vue.j starter app.
class: aws-icon-ps-60-network-nodes
url: '/media/hosting_guide'
icon: '/images/icons/Misc/Tool.svg'
services:
- title: Amazon CloudFront
url: https://aws.amazon.com/cloudfront/
- title: VS Code Extension
excerpt: Code snippets for AWS Amplify in Visual Studio Code.
cta: Read more
url: '/media/vuejs_guide'
class: aws-icon-ps-60-network-nodes
url_external: 'https://marketplace.visualstudio.com/items?itemName=aws-amplify.aws-amplify-vscode'
icon: '/images/icons/Misc/Present.svg'

- category: UserInterface
title: User Interface
excerpt:
base_url: '/media/ui_guide'
subs:
- title: UI Components
excerpt: UI excerpt
url: '/media/ui_guide'
icon: '/images/icons/Misc/Present.svg'

defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"


examples:
- title: Web apps
url: 'web-apps'
- title: React Native apps
url: 'react-native-apps'
- title: Hybrid Mobile
url: 'hybrid-mobile-apps'
- title: Static Websites
url: 'static-web-sites'
- title: Code Examples
url: 'examples'

styleguide:
- title: Colors
url: '#colors'
- title: 'Typography'
url: '#typography'
#- title: 'Controls'
# url: '#controls--inputs'
#- title: 'Widgets'
# url: '#widgets'
- title: Components
url: '#aws-components'

js_libraries:
- title: React
url: '?platform=react'
- title: React Native
url: '?platform=react-native'
- title: Angular
url: '?platform=angular'
- title: Ionic
url: '?platform=ionic'
- title: JavaScript
url: '?platform=purejs'
6 changes: 3 additions & 3 deletions docs/_layouts/default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
<meta http-equiv="X-UA-Compatible" content="chrome=1">

{% seo %}
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
<link rel="stylesheet" href="{{ '{% if jekyll.environment == 'production' %}{{ site.amplify.baseurl }}{% endif %}/amplify-theme/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="{{ '/assets/js/respond.js' | relative_url }}"></script>
<script src="{{ '{% if jekyll.environment == 'production' %}{{ site.amplify.baseurl }}{% endif %}/amplify-theme/assets/js/respond.js' | relative_url }}"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
Expand Down Expand Up @@ -241,7 +241,7 @@
<span>aws/aws-amplify</span>
</a>
<div id="topNav" class="navbar">
<a href="/amplify-js/media/quick_start.html">Quick Start</a>
<a href="/amplify-js/media/get_started.html">Quick Start</a>
<a id="githubLink" href="{{ site.github.repository_url }}" target="_blank" class="aws-button" style="float:right;color:#333 !important;">
<span>aws/aws-amplify</span>
</a>
Expand Down
Loading

0 comments on commit f519ff6

Please sign in to comment.