Skip to content

Commit 96a3a6d

Browse files
jimblancjimblanc
authored
Merge branch 'main' into patch-1
2 parents e538e1b + d2be591 commit 96a3a6d

File tree

1,619 files changed

+52020
-15532
lines changed

Some content is hidden

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

1,619 files changed

+52020
-15532
lines changed

‎.github/CODEOWNERS

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1 @@
1-
* @aws-amplify/amplify-support-eng
2-
/src/pages/** @aws-amplify/amplify-support-eng
3-
/src/pages/cli @aws-amplify/amplify-cli @aws-amplify/amplify-support-eng
4-
/src/pages/console @aws-amplify/amplify-hosting @aws-amplify/amplify-support-eng
5-
/src/pages/guides @aws-amplify/developer-advocates @aws-amplify/amplify-support-eng
6-
/src/fragments/** @aws-amplify/amplify-support-eng
7-
/src/fragments/**/android @aws-amplify/amplify-android @aws-amplify/amplify-support-eng
8-
/src/fragments/**/flutter @aws-amplify/amplify-flutter @aws-amplify/amplify-support-eng
9-
/src/fragments/**/ios @aws-amplify/amplify-ios @aws-amplify/amplify-support-eng
10-
/src/fragments/**/js @aws-amplify/amplify-js @aws-amplify/amplify-support-eng
11-
/src/fragments/cli @aws-amplify/amplify-cli @aws-amplify/amplify-support-eng
12-
/src/fragments/console @aws-amplify/amplify-hosting @aws-amplify/amplify-support-eng
13-
/src/fragments/guides @aws-amplify/developer-advocates @aws-amplify/amplify-support-eng
1+
* @aws-amplify/documentation-team

‎.github/ISSUE_TEMPLATE/content_issue.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Content Issue
3+
about: Create a report to point out content issues or missing content.
4+
5+
---
6+
7+
**Describe the content issue**:
8+
A clear and concise description of what the content issue is. Is there content missing or is there incorrect content?
9+
10+
**URL page where content issue is**:

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,40 @@
1-
_Issue #, if available:_
1+
#### Description of changes:
22

3-
_Description of changes:_
3+
#### Related GitHub issue #, if available:
44

5-
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
5+
### Instructions
6+
7+
**If this PR should not be merged upon approval for any reason, please submit as a DRAFT**
8+
9+
Which product(s) are affected by this PR (if applicable)?
10+
- [ ] amplify-cli
11+
- [ ] amplify-ui
12+
- [ ] amplify-studio
13+
- [ ] amplify-hosting
14+
- [ ] amplify-libraries
15+
16+
Which platform(s) are affected by this PR (if applicable)?
17+
- [ ] JS
18+
- [ ] iOS
19+
- [ ] Android
20+
- [ ] Flutter
21+
- [ ] React Native
22+
23+
**Please add the product(s)/platform(s) affected to the PR title**
24+
25+
#### Checks
26+
27+
- [ ] Does this PR conform to [the styleguide](https://github.com/aws-amplify/docs/blob/main/STYLEGUIDE.md)?
28+
29+
- [ ] Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
30+
31+
- [ ] Are any files being deleted with this PR? If so, have the needed redirects been created?
32+
33+
- [ ] Are all links in MDX files using the MDX link syntax rather than HTML link syntax? <br />
34+
_ref: MDX: `[link](https://link.com)`
35+
HTML: `<a href="https://link.com">link</a>`_
36+
37+
### When this PR is ready to merge, please check the box below
38+
- [ ] Ready to merge
39+
40+
_By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license._

‎.github/codeql/codeql-config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
paths-ignore:
2+
- public

‎.github/workflows/build.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ jobs:
3939
node-version: 14.x
4040
- name: Install Dependencies
4141
run: yarn
42-
- name: Run Spellcheck
43-
run: yarn spellcheck
4442
- name: Fetch Amplify backend configuration
4543
uses: ./.github/actions/fetch_amplify_backend
4644
with:

‎.github/workflows/codeql.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 'CodeQL'
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize]
6+
jobs:
7+
CodeQL-Build:
8+
name: CodeQL Build
9+
runs-on: ubuntu-latest
10+
permissions:
11+
actions: read
12+
contents: read
13+
security-events: write
14+
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
language: ['javascript']
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v3
23+
with:
24+
# Minimal depth 2 so we can checkout the commit before possible merge commit.
25+
fetch-depth: 2
26+
27+
# Initializes the CodeQL tools for scanning.
28+
- name: Initialize CodeQL
29+
uses: github/codeql-action/init@v2
30+
with:
31+
languages: ${{ matrix.language }}
32+
config-file: ./.github/codeql/codeql-config.yml
33+
34+
- name: Perform CodeQL Analysis
35+
uses: github/codeql-action/analyze@v2
36+
with:
37+
category: '/language:${{matrix.language}}'

‎.github/workflows/spellcheck.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Spellcheck
2+
on:
3+
pull_request:
4+
types: [opened, synchronize]
5+
permissions:
6+
contents: read
7+
jobs:
8+
Spellcheck:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout repository
12+
uses: actions/checkout@v3
13+
- name: Setup Node.js 14.x
14+
uses: actions/setup-node@main
15+
with:
16+
node-version: 14.x
17+
- name: Install Dependencies
18+
run: yarn
19+
- name: Run Spellcheck
20+
run: yarn spellcheck

‎.github/workflows/tagcheck.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: LinkTagCheck
2+
on:
3+
pull_request:
4+
types: [opened, synchronize]
5+
permissions:
6+
contents: read
7+
jobs:
8+
LinkTagCheck:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout repository
12+
uses: actions/checkout@v3
13+
- name: Setup Node.js 14.x
14+
uses: actions/setup-node@main
15+
with:
16+
node-version: 14.x
17+
- name: Install Dependencies
18+
run: yarn
19+
- name: Run Link Tag Check
20+
run: node tasks/check-link-tags.mjs

‎Readme.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
# Amplify Framework Documentation
1+
# Amplify Documentation
22

33
[![DiscordChat](https://img.shields.io/discord/308323056592486420?logo=discord")](https://discord.gg/amplify)
44

55
> https://docs.amplify.aws
66
7-
## Getting Started
7+
### Prerequisites
8+
9+
- [Node.js 14.x or later](https://nodejs.org/en/)
10+
- [Yarn classic](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable)
11+
12+
## Set up the docs repo
813

9-
1. [Fork this repo](/fork).
10-
2. `yarn && yarn dev`
14+
1. [Fork this repo](/fork) and `git clone` it.
15+
2. In your terminal, navigate to the repo from where it was just cloned. This should be located at the `/docs` directory.
16+
2. From your command line, run `yarn && yarn dev`
1117
3. <http://localhost:3000/> should open automatically.
1218

13-
## Contributing
19+
## How to contribute
1420

15-
We welcome contributions to the documentation site! Please verify your changes locally followed by a PR against our `main` branch. After your PR is reviewed and all tests pass, it will be merged and the branch will be deleted.
21+
We welcome contributions to the documentation site! Here's how to do it:
1622

17-
### Branches
23+
1. Follow our [styleguide](https://github.com/aws-amplify/docs/blob/main/STYLEGUIDE.md), especially if writing longer pieces.
24+
2. Verify your changes locally.
25+
3. Make a PR to our `main` branch
26+
1. Please include any [issues](https://github.com/aws-amplify/docs/issues) your PR addresses.
27+
2. If any files have been deleted with your PR, please indicate that `redirects are needed` in your PR description and/or add the `redirects-needed` label.
28+
29+
**What's next?** After your PR is reviewed and all tests pass, it will be merged and the branch will be deleted.
1830

19-
- `main` - at parity with our production site https://docs.amplify.aws/
20-
- `gh-pages` - used to handle redirects from v1 of the documentation site. This should not be deleted.
31+
### Branches
2132

22-
## Authoring Pages
33+
- **main** - at parity with our production site [docs.amplify.aws](https://docs.amplify.aws/)
34+
- **gh-pages** - DO NOT DELETE! Handle redirects from v1 of the documentation site.
2335

24-
Below is a full description of how to author pages. For now though, trigger the `dev` script (`yarn dev`).
36+
## Authoring pages
2537

26-
Docs are generated using [Next.js](https://nextjs.org/), please refer to their docs on how to create [pages](https://nextjs.org/docs/basic-features/pages) as a primer.
38+
Our docs are generated using [Next.js](https://nextjs.org/). Refer to their docs on [how to create pages](https://nextjs.org/docs/basic-features/pages) as a primer.
2739

28-
The root-level `src` folder is the only directory you need touch in order to CRUD pages.
40+
The pages' source are in **src**. This folder is the only directory you need touch in order to edit or create pages.
2941

30-
Within this folder exists a `pages/index.tsx` file. This will be rendered as a page at the route `/`. Within the `src/pages/lib/q/platform/` folder is a `[platform].mdx` file, which will be rendered as a page at the route `/lib`.
42+
Within this folder exists a **pages/index.tsx** file. This will be rendered as a page at the route **/**. Within the **pages/lib/q/platform/** folder is a **[platform].mdx** file, which will be rendered as a page at the route **/lib**.
3143

32-
In order to have the page render properly and display in the sidebar, please place your page and it's route in `src/directory/directory.js`
44+
In order to have the page render properly and display in the sidebar, please place your page and it's route in **src/directory/directory.js**
3345

3446
IMPORTANT: every page has to have a `title` and `description` meta field.
3547

0 commit comments

Comments
 (0)