diff --git a/.changeset/rare-buttons-dress.md b/.changeset/rare-buttons-dress.md new file mode 100644 index 0000000000..e539191d6b --- /dev/null +++ b/.changeset/rare-buttons-dress.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-devtools': minor +--- + +Updated DevTools documentation for Docker users diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md index 8f8f128403..0ad7bfae61 100644 --- a/plugins/devtools/README.md +++ b/plugins/devtools/README.md @@ -12,14 +12,6 @@ Lists helpful information about your current running Backstage instance such as: ![Example of Info tab](./docs/devtools-info-tab.png) -### Config - -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 mitigate this it is highly recommended that you enable the [permission framework](https://backstage.io/docs/permissions/overview) and [apply the proper permissions](#permissions)). If you do see secrets in clear text please contact the plugin's author to get the visibility set to secret for the applicable property. - -![Example of Config tab](./docs/devtools-config-tab.png) - #### Backstage Version Reporting The Backstage Version that is reported requires `backstage.json` to be present at the root of the running backstage instance. @@ -34,6 +26,14 @@ ENV NODE_ENV production COPY --chown=node:node ... backstage.json ./ ``` +### Config + +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 mitigate this it is highly recommended that you enable the [permission framework](https://backstage.io/docs/permissions/overview) and [apply the proper permissions](#permissions)). If you do see secrets in clear text please contact the plugin's author to get the visibility set to secret for the applicable property. + +![Example of Config tab](./docs/devtools-config-tab.png) + ## Optional Features The DevTools plugin can be setup with other tabs with additional helpful features.