Skip to content

Commit

Permalink
Merge branch 'main' into docs/services-grid-view
Browse files Browse the repository at this point in the history
  • Loading branch information
dericksozo authored Nov 7, 2024
2 parents beab31b + 7c849b9 commit 3d3a8e1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/plugins/define-plugin-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This file lives at the root of your plugin directory.
It contains two properties at the root level:

- `settings`: User-facing configuration.
- `systemSettings` - Internal configuration.
- `systemSettings`: Internal configuration.

```json title=".amplicationrc.json"
{
Expand All @@ -25,7 +25,7 @@ It contains two properties at the root level:
"dbName": "my-db"
},
"systemSettings": {
"requireAuth": true
"requireAuthenticationEntity": true
}
}
```
Expand All @@ -52,9 +52,7 @@ The `systemSettings` property is used to contain internal configuration that you
These settings are **not visible to the user** and are solely for use in your plugin's code.

:::caution
**`systemSettings` is currently only available for internal developers** and not community developers.
For now, use `systemSettings` to structure your `.amplicationrc.json` correctly.
In the future, more documentation will be provided on what internal `systemSettings` are available.
`requireAuthenticationEntity` is the only property available in the systemSettings configuration object. Also, **`systemSettings` is currently only available for internal developers** and not community developers.
:::

## Examples
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ const sidebars = {
"plugins/overview",
"plugins/plugin-architecture",
"plugins/how-to-create-plugin",
"plugins/define-plugin-settings",
"plugins/how-to-test-plugin",
"plugins/publish-plugin",
"plugins/plugin-events-before-after",
Expand Down

0 comments on commit 3d3a8e1

Please sign in to comment.