From 7d3966683df482b91609a38e9fb7ddad718fa38e Mon Sep 17 00:00:00 2001 From: Derick Sozo Date: Thu, 31 Oct 2024 12:10:06 +0700 Subject: [PATCH] (docs): Renaming the property in the docs from to for the systemSettings configuration object. Also adding the page to the sidebar. --- docs/plugins/define-plugin-settings.md | 8 +++----- sidebars.js | 1 + 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/plugins/define-plugin-settings.md b/docs/plugins/define-plugin-settings.md index 9615f296..7367f93e 100644 --- a/docs/plugins/define-plugin-settings.md +++ b/docs/plugins/define-plugin-settings.md @@ -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" { @@ -25,7 +25,7 @@ It contains two properties at the root level: "dbName": "my-db" }, "systemSettings": { - "requireAuth": true + "requireAuthenticationEntity": true } } ``` @@ -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 diff --git a/sidebars.js b/sidebars.js index 3def1820..e4bbfd29 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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",