Skip to content

Commit 94b6821

Browse files
hbuchelHeather Buchel
andauthored
docs: move troubleshooting to new page (#1959)
* docs: move troubleshooting to new page Co-authored-by: Heather Buchel <[email protected]>
1 parent 9629575 commit 94b6821

File tree

7 files changed

+38
-31
lines changed

7 files changed

+38
-31
lines changed

docs/src/components/Layout/SecondaryNav.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,11 @@ export const SecondaryNav = (props) => {
141141
Migration
142142
</NavLink>
143143
)}
144+
{platform !== 'flutter' && (
145+
<NavLink {...props} href="/getting-started/troubleshooting">
146+
Troubleshooting
147+
</NavLink>
148+
)}
144149
</>
145150
);
146151
case 'components':

docs/src/pages/[platform]/getting-started/installation/dependencies.vue.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,21 @@ yarn add aws-amplify @aws-amplify/ui-vue
2525
documentation](https://github.com/aws-amplify/amplify-ui/tree/legacy/legacy/amplify-ui-vue)
2626
please click here.
2727
</Alert>
28+
29+
### Register as a global plugin (Optional)
30+
31+
Optionally, you can register all the `@aws-amplify/ui-vue` components at once.
32+
33+
```js
34+
// main.js
35+
import { createApp } from 'vue';
36+
import App from './App.vue';
37+
import AmplifyVue from '@aws-amplify/ui-vue';
38+
39+
const app = createApp(App);
40+
app.use(AmplifyVue);
41+
app.mount('#app');
42+
```
43+
44+
Otherwise, you can import individual components from the `@aws-amplify/ui-vue` package in each one of your components.
45+

docs/src/pages/[platform]/getting-started/installation/index.page.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,3 @@ import { Fragment } from '@/components/Fragment';
2323
<Fragment platforms={['web']} useCommonWebContent>
2424
{({ platform }) => import(`./fonts.${platform}.mdx`)}
2525
</Fragment>
26-
27-
<Fragment platforms={['react', 'vue', 'angular']}>
28-
{({ platform }) => import(`./troubleshooting.${platform}.mdx`)}
29-
</Fragment>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Troubleshooting
3+
metaTitle: Troubleshooting
4+
description: Workarounds for common issues using Amplify UI.
5+
supportedFrameworks: react|angular|vue
6+
---
7+
8+
import Link from 'next/link';
9+
import { Fragment } from '@/components/Fragment';
10+
11+
<Fragment>{({ platform }) => import(`./troubleshooting.${platform}.mdx`)}</Fragment>

docs/src/pages/[platform]/getting-started/installation/troubleshooting.angular.mdx renamed to docs/src/pages/[platform]/getting-started/troubleshooting/troubleshooting.angular.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
## Troubleshooting
2-
31
### Global and Process Shim
42

53
Angular 6+ no longer include shims for 'global' or 'process'. Add the following to your `src/polyfills.ts`:

docs/src/pages/[platform]/getting-started/installation/troubleshooting.react.mdx renamed to docs/src/pages/[platform]/getting-started/troubleshooting/troubleshooting.react.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import { Alert, Tabs, TabItem } from '@aws-amplify/ui-react';
22

3-
## Troubleshooting
4-
5-
### Webpack 5+
3+
## Webpack 5+
64

75
Follow the instructions below to if you are using Webpack 5:
86

@@ -47,7 +45,7 @@ yarn add node-polyfill-webpack-plugin -D
4745
],
4846
```
4947

50-
### Vite
48+
## Vite
5149

5250
When working with a [Vite](https://vitejs.dev) project you must make a few modifications. Please follow the steps below.
5351

@@ -91,7 +89,7 @@ export default defineConfig({
9189
...
9290
```
9391
94-
### Jest
92+
## Jest
9593
9694
As of v2.15.0 of `@aws-amplify/ui-react` which included the release of Geo components, users of the Jest testing framework may run into the following error when attempting to run tests:
9795

docs/src/pages/[platform]/getting-started/installation/troubleshooting.vue.mdx renamed to docs/src/pages/[platform]/getting-started/troubleshooting/troubleshooting.vue.mdx

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,4 @@
1-
## Install as a global plugin (Optional)
2-
3-
Optionally, you can register all the `@aws-amplify/ui-vue` components at once.
4-
5-
```js
6-
// main.js
7-
import { createApp } from 'vue';
8-
import App from './App.vue';
9-
import AmplifyVue from '@aws-amplify/ui-vue';
10-
11-
const app = createApp(App);
12-
app.use(AmplifyVue);
13-
app.mount('#app');
14-
```
15-
16-
Otherwise, you can import individual components from the `@aws-amplify/ui-vue` package in each one of your components.
17-
18-
## Troubleshooting
19-
20-
### Vite
1+
## Vite
212

223
When working with a [Vite](https://vitejs.dev) project you must make a few modifications. Please follow the steps below.
234

0 commit comments

Comments
 (0)