Skip to content

Commit 25a348e

Browse files
authored
fix: highlights, formatting and others on studio (#5424)
* fix: highlights, formatting and others * fix: wording * fix: minor improvements * fix: wording and remove comment
1 parent 8af6ee5 commit 25a348e

File tree

12 files changed

+35
-39
lines changed

12 files changed

+35
-39
lines changed

src/pages/console/adminui/access-management.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const meta = {
33
description: `Manage team access to a project`,
44
};
55

6-
With Amplify Studio, team members with different job functions can collaborate on different aspects of a project deployed in Amplify. Studio developers can create accounts with scoped access to resources and invite team members to join via email. Team members with *Full access* can create and manage AWS resources, while team members with *Manage only* access can edit application content and users.
6+
With Amplify Studio, team members with different job functions can collaborate on different aspects of a project deployed in Amplify. Studio developers can create accounts with admin or manage-only access to resources and invite team members to join via email.
77

88
Follow these instructions to add and manage team members and their access to a project.
99

@@ -35,7 +35,9 @@ Follow these instructions to add and manage team members and their access to a p
3535
* Choose **Delete**. In the **Delete users** window, confirm the delete action.
3636

3737
<Callout warning>
38-
If a team member logs into Amplify Studio, their login token is valid for 60 minutes, unless explicitly logged out. When you change a team member's permission from *full access* to *manage-only* or when you delete a team member's access, the team member can continue accessing Amplify Studio with their previously granted permissions until their token expires.
38+
39+
If a team member logs into Amplify Studio, their login token is valid for 5 hours 30 minutes, unless they explicitly log out. When you change a team member's permission from **Full access** to **Manage only** or when you delete a team member's access, the team member can continue accessing Amplify Studio with their previously granted permissions until their token expires.
40+
3941
</Callout>
4042

4143
## Understanding how Studio manages user access

src/pages/console/data/content-management.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ To use the data manager, you can [adjust your GraphQL API settings.](/console/da
7878
### Null required fields
7979
When using the data manager, you may encounter the following error message:
8080

81-
<Callout info>
81+
```console
8282

83-
"Field {{fieldName}} cannot be set to null since its a required field."
83+
Field {{fieldName}} cannot be set to null since it's a required field.
8484

85-
</Callout>
85+
```
8686

8787
This message occurs when there are records in the selected data model that have null values for required fields. Usually, this occurs because a field was changed to be required after records were created. To resolve this issue, null records need to be updated.
8888

@@ -106,11 +106,11 @@ A bi-directionally required field is a Relationship field between two data model
106106
### Change of type in fields
107107
When using the data manager, you may encounter the following error message:
108108

109-
<Callout info>
109+
```console
110110

111-
"Field {{fieldName}} has a type mismatch. Expected {{typeName}}, but got {{typeName}}"
111+
Field {{fieldName}} has a type mismatch. Expected {{typeName}}, but got {{typeName}}
112112

113-
</Callout>
113+
```
114114

115115
This message occurs when there are records in the selected data model that have a mismatch in the expected type of a field. Usually, this occurs because a field was updated with a new type after records were created. To resolve this issue, records need to be updated.
116116

src/pages/console/formbuilder/customize.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Spacing values can either be a CSS length value (`px`, `rem`, `em`, `%`) or a re
8383

8484
## Enable list inputs
8585

86-
Form inputs can be made to accept multiple values. The form input gets "wrapped" around by a "list input" component to allow your users to add, update, and remove items. **This functionality is only enabled for inputs not tied to a data model.** If your input is tied to one of your existing models, this feature is controlled directly on the model by toggling the **Is array** property on the corresponding field and deploying your update.
86+
`TextInput`s can accept multiple values by toggling "Accept multiple values", enabling users to add, update, and remove items. This functionality is only enabled for inputs not linked to a data model. If your input is linked to an existing model, this feature is controlled directly on the model by toggling the "Is array" property on the corresponding field.
8787

8888
1. Select a form input that's not connected to a data model
8989
2. Go to **Data**

src/pages/console/formbuilder/lifecycle.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ For example, if you want to trim all the string data before saving it:
7171
```jsx
7272
<HomeCreateForm
7373
onSubmit={(fields) => {
74-
// Example function to trim all string inputs
7574
const updatedFields = {}
7675
Object.keys(fields).forEach(key => {
7776
if (typeof fields[key] === 'string') {

src/pages/console/formbuilder/overrides.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ Use the `overrides` property to select the input component you want to override
1212

1313
```jsx
1414
function ProductFormContainer({ productType }) {
15-
// "productType" is dynamically passed into this
16-
// container component as a React prop (e.g. "shoe", "phone")
17-
1815
return (
1916
<div className="App">
2017
<ProductForm
@@ -29,4 +26,4 @@ function ProductFormContainer({ productType }) {
2926
}
3027
```
3128

32-
**Note:** we do not recommend overriding properties that are already set by the generated form. This could lead to unexpected behavior during runtime. Verify the set properties by navigating to the component in the `src/ui-components/<your-form-component>.jsx` file.
29+
**Note:** We do not recommend overriding properties that are already set by the generated form. This could lead to unexpected behavior during runtime. Verify the set properties by navigating to the component in the `src/ui-components/<your-form-component>.jsx` file.

src/pages/console/tutorial/bindui.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To add a property, choose **Add prop** and set a name for your property. For thi
1111

1212
## Set child property values
1313

14-
Select a child element such as the "\$99 USD" Text element and choose \*\*Set prop\*\*. Here, you are able to set all available properties for that child element. Configure the `label` for the text element and set the value to "Price: \$" and then select _Command + Enter_ on your keyboard to concatenate another value such as `home.price`.
14+
Select a child element such as the `$99 USD` Text element and choose **Set prop**. Here, you are able to set all available properties for that child element. Configure the `label` for the text element and set the value to `Price: $` and then select _Command + Enter_ (or _Ctrl + Enter_) on your keyboard to concatenate another value such as `home.price`.
1515

1616
![Screenshot of UI bound to data](/images/studio/data-binding.png)
1717

src/pages/console/tutorial/buildui.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const meta = {
33
description: `Figma to React code with Amplify Studio`
44
};
55

6-
With Studio’s new UI Library, you can sync components from Figma to React code. Amplify also provides you with a handy Figma file to get started faster. The Amplify Figma file includes both UI primitives and component templates. You can also create your own component in Figma! In this tutorial, you'll create a home listings app using Amplify Studio.
6+
With Studio’s new **UI Library**, you can sync components from Figma to React code. Amplify also provides you with a handy Figma file to get started faster. The Amplify Figma file includes both UI primitives and component templates. You can also create your own component in Figma! In this tutorial, you'll create a home listings app using Amplify Studio.
77

88
## Create UI components in Figma
99

@@ -50,10 +50,11 @@ Next, run `amplify pull` to sync all your components into your local code base.
5050
Import the UI component you want from `./ui-components` and then render it in your React app. For example:
5151

5252
```js
53-
import { CardB } from './ui-components'
54-
...
55-
return <div>
53+
import { CardB } from './ui-components';
54+
55+
return (
56+
<div>
5657
<CardB />
5758
</div>
58-
...
59+
);
5960
```

src/pages/console/tutorial/collections.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const meta = {
33
description: `Figma to React code with Amplify Studio`
44
};
55

6-
Amplify Studio also allows you to build lists and grids based on individual UI components. Let's create a "NewHomes" grid that showcases the latest homes added to the app.
6+
Amplify Studio also allows you to build lists and grids based on individual UI components. Let's create a `NewHomes` grid that showcases the latest homes added to the app.
77

88
## Create a collection
99

src/pages/console/tutorial/data.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ Amplify Studio provides a visual way to create your app's data model and manage
77

88
## Create data model
99

10-
In [Amplify Studio](/console/adminui/start/#logging-in-and-creating-an-app), from the **Set up** menu, choose **Data**. On the **Data modeling** page, choose **Add model** to create your first data model. Think of a model as a table in your database.
10+
1. [Launch Studio](/console/adminui/start/#logging-in-and-creating-an-app) for an app
11+
1. On the **Set up** menu, choose **Data**
12+
1. On the **Data modeling** page, choose **Add model** to create your first data model.
1113

12-
In this case, you'll create a `Home` model and add a few fields like `address (String)`, `price (Float)`, and `image_url (String)`.
14+
Think of a model as a table in your database. In this case, you'll create a `Home` model and add a few fields like `address (String)`, `price (Float)`, and `image_url (String)`.
1315

1416
![Screenshot showing the "Add Model" button](/images/studio/add-model.png)
1517

src/pages/console/uibuilder/figmatocode.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ In order to upgrade your Figma file, the newest version of all Amplify UI primit
9191

9292
1. Duplicate the new [Figma community file](https://www.figma.com/community/file/1047600760128127424) into your Figma account.
9393
![Duplicate the new figma file](/images/console/ui-figma-file.png)
94-
1. Copy everything in the 'README' page of the cloned community file into your existing customized Figma file
95-
* If your Figma file doesn't have a 'README' page, create new page named README
96-
1. Delete all content in the 'Primitives' page of your customized Figma file
97-
1. Copy everything in the 'Primitives' page of the cloned Figma file, and paste it into the 'Primitives' page of your customized Figma file.
98-
1. Go through each component on the 'My Components' page and update the broken component instances to point to the local components on the 'Primitives' page. Unfortunately, there is no easy way to bulk update component instances in Figma.
94+
1. Copy everything in the **README** page of the cloned community file into your existing customized Figma file
95+
* If your Figma file doesn't have a **README** page, create new page named **README**
96+
1. Delete all content in the **Primitives** page of your customized Figma file
97+
1. Copy everything in the **Primitives** page of the cloned Figma file, and paste it into the **Primitives** page of your customized Figma file.
98+
1. Go through each component on the **My Components** page and update the broken component instances to point to the local components on the **Primitives** page. Unfortunately, there is no easy way to bulk update component instances in Figma.
9999
![Reattach figma components](/images/console/figma-upgrade-reattach.gif)
100100

101101
**It is important to reattach your primitives. If you skip this step, Amplify Studio will generate components that look correct, but the React code generated will not use the [Amplify UI components](https://ui.docs.amplify.aws), and may not behave as expected**

0 commit comments

Comments
 (0)