paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

address config schema review comments

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-11-17 18:25:55 +01:00
parent 39591369ba
commit 0b97a89f55
8 changed files with 39 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf/index.md
+4 -4
View File
@@ -35,15 +35,15 @@ For more details, see [Writing Configuration](./writing.md).
## Configuration Schema
The configuration is validated using a JSON Schema definitions. Each plugin and
package can provide pieces of the configuration schema, which is stitched
The configuration is validated using JSON Schema definitions. Each plugin and
package can provide pieces of the configuration schema, which are stitched
together to form a complete schema during validation. The configuration schema
is also used to select what configuration is available in the frontend using a
custom `visibility` keyword, as configuration is by default only available in
the backend.
You can validate your configuration against the schema using
`backstage-cli config:validate`, and define schema for your own plugin either
`backstage-cli config:validate`, and define a schema for your own plugin either
using JSON Schema or TypeScript. For more information, see
[Defining Configuration](./defining.md).
@@ -63,5 +63,5 @@ More details are provided in dedicated sections of the documentation.
plugin.
- [Writing Configuration](./writing.md): How to provide configuration for your
Backstage deployment.
- [Defining Configuration](./defining.md): How to define configuration schema
- [Defining Configuration](./defining.md): How to define a configuration schema
for users of your plugin or package.