From 23ad991a173d1eea23213658a1450d2bd38c7cf5 Mon Sep 17 00:00:00 2001
From: Crevil <bjoern.soerensen@gmail.com>
Date: Thu, 17 Jun 2021 09:20:45 +0200
Subject: [PATCH] Add example of visibility of config values

Emphasize how to set config visibility in the docs with an example.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>
---
 docs/conf/defining.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/conf/defining.md b/docs/conf/defining.md
index 34b9b11977..f13beb9f77 100644
--- a/docs/conf/defining.md
+++ b/docs/conf/defining.md
@@ -93,6 +93,21 @@ declare the visibility of a leaf node of `type: "string"`.
 | `backend`    | (Default) Only in backend                                          |
 | `secret`     | Only in backend and may be excluded from logs for security reasons |
 
+You can set visibility with an `@visibility` comment in the `Config` Typescript
+interface.
+
+```ts
+export interface Config {
+  app: {
+    /**
+     * Frontend root URL
+     * @visibility frontend
+     */
+    baseUrl: string;
+  };
+}
+```
+
 ## Validation
 
 Schemas can be validated using the `backstage-cli config:check` command. If you