From c2a8312a939fdc1ec4ef9b3078387d10d3fa702b Mon Sep 17 00:00:00 2001 From: deepthi-28 Date: Wed, 5 Feb 2025 11:35:27 +0530 Subject: [PATCH] Updated documentation of write backstage Signed-off-by: deepthi-28 --- docs/conf/writing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/conf/writing.md b/docs/conf/writing.md index 85a719e1d0..36a6f330e0 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -239,7 +239,8 @@ privateKey: | -----END RSA PRIVATE KEY----- ``` -> [!WARNING] -> Sensitive information, such as private keys, should not be hard coded. +:::warning +Sensitive information, such as private keys, should not be hard coded. +::: We recommend that this entire file should be a secret and stored as such in a secure storage solution like Vault, to ensure they are neither exposed nor misused. This example key part only shows the format on how to use the yaml | syntax to make sure that the key is valid.