-
Notifications
You must be signed in to change notification settings - Fork 591
doc: polish release doc #2531
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
doc: polish release doc #2531
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
700eb13
doc:polish release note
suyanhanx 722fd2d
add `build-from-source`
suyanhanx a5f54b9
Update website/docs/contributing/release.md
suyanhanx a510f9a
Revert "add `build-from-source`"
suyanhanx baae2af
polish
suyanhanx 5c14777
add verify release candidate doc
suyanhanx 3e66c5b
Merge branch 'polish-release-doc' of github.com:suyanhanx/opendal int…
suyanhanx 64526ce
polish
suyanhanx a5b3967
fix
suyanhanx File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,15 +4,15 @@ title: Setup GPG Key | |
|
||
> This section is a brief from the [Cryptography with OpenPGP](https://infra.apache.org/openpgp.html) guideline. | ||
|
||
## Install gpg | ||
## Install GPG | ||
|
||
For more details, please refer to [GPG official website](https://www.gnupg.org/download/index.html). Here shows one approach to install GPG with `apt`: | ||
|
||
```shell | ||
sudo apt install gnupg2 | ||
``` | ||
|
||
## Generate gpg Key | ||
## Generate GPG Key | ||
|
||
Attentions: | ||
|
||
|
@@ -73,7 +73,7 @@ generator a better chance to gain enough entropy. | |
│ │ | ||
│ <OK> <Cancel> │ | ||
└──────────────────────────────────────────────────────┘ | ||
# key generatio[n will be done after your inputting the key with the following output | ||
# key generation will be done after your inputting the key with the following output | ||
gpg: key E49B00F626B marked as ultimately trusted | ||
gpg: revocation certificate stored as '/Users/hulk/.gnupg/openpgp-revocs.d/F77B887A4F25A9468C513E9AA3008E49B00F626B.rev' | ||
public and secret key created and signed. | ||
|
@@ -84,7 +84,7 @@ uid [ultimate] hulk <[email protected]> | |
sub rsa4096 2022-07-12 [E] | ||
``` | ||
|
||
## Upload your key to public gpg keyserver | ||
## Upload your key to public GPG keyserver | ||
|
||
Firstly, list your key: | ||
|
||
|
@@ -112,15 +112,15 @@ Among them, `keys.openpgp.org` is a randomly selected keyserver, you can use `ke | |
|
||
## Check whether the key is created successfully | ||
|
||
Uploading takes about one minute, after that, you can check by your email at the corresponding keyserver. | ||
Uploading takes about one minute; after that, you can check by your email at the corresponding keyserver. | ||
|
||
Uploading keys to the keyserver is mainly for joining a [Web of Trust](https://infra.apache.org/release-signing.html#web-of-trust). | ||
|
||
## Add your gpg public key to the KEYS document | ||
## Add your GPG public key to the KEYS document | ||
|
||
:::info | ||
|
||
SVN is required for this step. | ||
`SVN` is required for this step. | ||
|
||
::: | ||
|
||
|
@@ -139,5 +139,5 @@ svn ci -m "add gpg key for YOUR_NAME" # Later on, if you are asked to enter a us | |
|
||
## Upload the GPG public key to your GitHub account | ||
|
||
- Enter https://github.com/settings/keys to add GPG KEYS. | ||
- Enter https://github.com/settings/keys to add your GPG key. | ||
- Please remember to bind the email address used in the GPG key to your GitHub account (https://github.com/settings/emails) if you find "unverified" after adding it. |
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.