Create a FAQ document for Sealed Secrets public documentation #1269
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
alemorcuq
reviewed
Jul 12, 2023
alemorcuq
reviewed
Jul 12, 2023
| If you do want to make a backup of the encryption private keys, it's easy to do from an account with suitable access: | ||
|
|
||
| ```console | ||
| $ kubectl get secret -n kube-system -l sealedsecrets.bitnami.com/sealed-secrets-key -o yaml >main.key |
There was a problem hiding this comment.
Are we choosing to use leading $ for commands or not? I see uses of both alternatives.
There was a problem hiding this comment.
I think the general rule is to use
shellwhen we show only the command (and no $)consolewhen showing the command and it's return values (and then use the $ to make it clear what's a command and what's a result)
There was a problem hiding this comment.
We don't seem to be following that convention in these files, we should fix that.
There was a problem hiding this comment.
I guess this one should be shell as it has no outputs
Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
alemorcuq
reviewed
Jul 12, 2023
Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
alvneiayu
requested changes
Jul 13, 2023
Apply suggestion Co-authored-by: Alejandro Moreno <amorenoc@vmware.com> Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
Apply suggestion Co-authored-by: Alvaro Neira Ayuso <alvaroneay@gmail.com> Signed-off-by: Alfredo Garcia <algarcia@vmware.com>
alemorcuq
approved these changes
Jul 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change
The Sealed Secrets public site needs a new page for frequently asked questions. This page will replace the current entry in the README file.
Unrelated, the PR also includes a TOC section in the
cryptographydocument