Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -190,6 +190,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
Loading