Added note about how secrets are displayed

Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-05-24 12:16:29 -05:00
parent 0eea1e0304
commit bbe15f70c5
2 changed files with 7 additions and 0 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-devtools': patch
+---
+
+Added note to README about how secrets are displayed in the Config tab of the DevTools plugin
@@ -16,6 +16,8 @@ Lists helpful information about your current running Backstage instance such as:

 Lists the configuration being used by your current running Backstage instance.

+**Note:** The Config tab uses the configuration schema [defined by each plugin](https://backstage.io/docs/conf/defining) to be able to mask secrets. It does this by checking that the [visibility](https://backstage.io/docs/conf/defining#visibility) has been marked as `secret`. If this is not set then the secret will appear in clear text. To avoid this it is highly recommended that you enable the [permission framework](https://backstage.io/docs/permissions/overview) and [apply the proper permissions](#permissions)).
+
 ![Example of Config tab](./docs/devtools-config-tab.png)

 ## Optional Features