Improve Repo Sharing Docs #184
Open
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
This was missing some key information on who should run what commands and what you need to run to decrypt a cloned repo (we should probably also write a `plural clone` command that compresses that into one command)
michaeljguarino
added
tutorial
✅ Deploy Preview for pluraldocs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
dogmar
reviewed
Jun 15, 2023
| ### Register a public key | ||
|
|
||
| To register a key for your current machine, run: | ||
| First, Alice and Bob both need to register age keypairs with plural. To do that register, they should both run this command on their current machine: |
There was a problem hiding this comment.
Suggested change
| First, Alice and Bob both need to register age keypairs with plural. To do that register, they should both run this command on their current machine: | |
| First, Alice and Bob both need to register age keypairs with Plural. To do that registration, they should both run this command on their current machine: |
| plural deploy --commit "set up encryption" | ||
| ``` | ||
|
|
||
| Regardless, whether the console is installed or not, you should be sure the files written locally were pushed upstream, which can also be done with: |
There was a problem hiding this comment.
Suggested change
| Regardless, whether the console is installed or not, you should be sure the files written locally were pushed upstream, which can also be done with: | |
| Regardless of whether the console is installed or not, you should ensure the locally-written files were pushed upstream, which can be done with: |
|
|
||
| ### Bob Decrypts the Repository | ||
|
|
||
| Now that the keypairs are registered, and repo encryption has moved to using age, Bob should be able to freely decrypt the repo, which is done simply by: |
There was a problem hiding this comment.
Suggested change
| Now that the keypairs are registered, and repo encryption has moved to using age, Bob should be able to freely decrypt the repo, which is done simply by: | |
| Now that the keypairs are registered and repo encryption has moved to using age, Bob should be able to freely decrypt the repo, which is done simply by: |
|
|
||
| ### Helpful Hints | ||
|
|
||
| - Encryption keys are stored locally or in plural's keybackups, so if new teammate gets a new machine, you'll likely need to do this process again for that teammate. |
There was a problem hiding this comment.
Suggested change
| - Encryption keys are stored locally or in plural's keybackups, so if new teammate gets a new machine, you'll likely need to do this process again for that teammate. | |
| - Encryption keys are stored locally or in Plural's keybackups, so if a new teammate gets a new machine, you'll likely need to do this process again for that teammate. |
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.
Summary
This was missing some key information on who should run what commands and what you need to run to decrypt a cloned repo (we should probably also write a
plural clonecommand that compresses that into one command)Test Plan
n/a
Checklist