From 90c5f9db54587d8da544912139ffce6930ac0572 Mon Sep 17 00:00:00 2001
From: Alex <52247724+Elya29@users.noreply.github.com>
Date: Thu, 25 Jan 2024 10:32:34 +0100
Subject: [PATCH 1/3] Update writing.md

add warning about hard coded RSA Private Keys.

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
---
 docs/conf/writing.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/conf/writing.md b/docs/conf/writing.md
index aef9620373..b2c098e12b 100644
--- a/docs/conf/writing.md
+++ b/docs/conf/writing.md
@@ -220,6 +220,8 @@ clientSecret: someGithubAppClientSecret
 webhookSecret: someWebhookSecret
 privateKey: |
   -----BEGIN RSA PRIVATE KEY-----
-  SomeRsaPrivateKey
+  SomeRsaPrivateKeyForExampleOnly
   -----END RSA PRIVATE KEY-----
 ```
+
+**Warning: RSA private keys should not be hard coded**. Keep them in a secure storage solution like Vault, to ensure they are neither exposed nor misused.

From 93bb6b425fce93621182dcc289b24a20bc583df5 Mon Sep 17 00:00:00 2001
From: Alex <52247724+Elya29@users.noreply.github.com>
Date: Mon, 29 Jan 2024 10:30:57 +0100
Subject: [PATCH 2/3] Update writing.md

Edit message to be more explicit about the secret RSA private keys

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
---
 docs/conf/writing.md | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/docs/conf/writing.md b/docs/conf/writing.md
index b2c098e12b..b5515f8618 100644
--- a/docs/conf/writing.md
+++ b/docs/conf/writing.md
@@ -218,10 +218,7 @@ webhookUrl: https://smee.io/foo
 clientId: someGithubAppClientId
 clientSecret: someGithubAppClientSecret
 webhookSecret: someWebhookSecret
-privateKey: |
-  -----BEGIN RSA PRIVATE KEY-----
-  SomeRsaPrivateKeyForExampleOnly
-  -----END RSA PRIVATE KEY-----
+privateKey: someSecretRsaPrivateKey
 ```
 
-**Warning: RSA private keys should not be hard coded**. Keep them in a secure storage solution like Vault, to ensure they are neither exposed nor misused.
+**Warning: RSA 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.

From 4841d6db89c6678b44f730109512b10294a1596e Mon Sep 17 00:00:00 2001
From: Alex <52247724+Elya29@users.noreply.github.com>
Date: Fri, 2 Feb 2024 14:19:22 +0100
Subject: [PATCH 3/3] Update writing.md

apply suggestions

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
---
 docs/conf/writing.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/docs/conf/writing.md b/docs/conf/writing.md
index b5515f8618..e0eb72f828 100644
--- a/docs/conf/writing.md
+++ b/docs/conf/writing.md
@@ -218,7 +218,10 @@ webhookUrl: https://smee.io/foo
 clientId: someGithubAppClientId
 clientSecret: someGithubAppClientSecret
 webhookSecret: someWebhookSecret
-privateKey: someSecretRsaPrivateKey
+privateKey: |
+  -----BEGIN RSA PRIVATE KEY-----
+  SomeRsaPrivateKeySecurelyStored
+  -----END RSA PRIVATE KEY-----
 ```
 
-**Warning: RSA 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.
+**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.