This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 9cf54135c docs: add new committer landing doc (#2905)
9cf54135c is described below
commit 9cf54135ce9c584919228be1efb335bc49cdad59
Author: Liuqing Yue <[email protected]>
AuthorDate: Tue Aug 22 22:03:12 2023 +0800
docs: add new committer landing doc (#2905)
* save work
* docs: add new committer landing doc
Signed-off-by: Liuqing Yue <[email protected]>
* docs: improve
Signed-off-by: Liuqing Yue <[email protected]>
* docs: add 1password setup
Co-authored-by: Xuanwo <[email protected]>
---------
Signed-off-by: Liuqing Yue <[email protected]>
Co-authored-by: Xuanwo <[email protected]>
---
integrations/README.md | 2 +-
website/docs/contributing/committer.md | 85 +++++++++++++++++++++++
website/docs/contributing/gmail-smtp-setting.jpg | Bin 0 -> 149264 bytes
3 files changed, 86 insertions(+), 1 deletion(-)
diff --git a/integrations/README.md b/integrations/README.md
index eabdeb3b8..dd89e76cf 100644
--- a/integrations/README.md
+++ b/integrations/README.md
@@ -1,6 +1,6 @@
# OpenDAL Integrations
-This folder contains the integrations for OpenDAL. Integrations are used to
ingrate OpenDAL with other systems.
+This folder contains the integrations for OpenDAL. Integrations are used to
integrate OpenDAL with other systems.
## Available Integrations
diff --git a/website/docs/contributing/committer.md
b/website/docs/contributing/committer.md
new file mode 100644
index 000000000..ca64c9032
--- /dev/null
+++ b/website/docs/contributing/committer.md
@@ -0,0 +1,85 @@
+---
+title: New Committer Landing Guide
+sidebar_position: 3
+---
+
+This document primarily serves as a guide for new committers to OpenDAL.
+
+Upon receiving an invitation email from OpenDAL's PPMC, a new committer should
consider whether to accept. If they decide in favor, they should select "Reply
All" and express their decision.
+
+## Submit CLA
+
+1. Download the ICLA from
https://www.apache.org/licenses/contributor-agreements.html#clas. If a
corporation assigns employees to work on an Apache project, please download the
CCLA.
+2. Complete the ICLA based on your particulars. Please note:
+ - The address field should be filled out accurately and in detail.
+ - You need to choose a unique ApacheID that hasn't been taken. Check
https://people.apache.org/committer-index.html to see which IDs are still
available.
+3. Sign document by hand or by electronic signature
+ - Manually sign a printed copy, then scan it to produce a pdf.
+ - Digitally draw a signature on the document: [Detail
Instruction](https://www.apache.org/licenses/cla-faq.html#printer).
+ - Sign the document using PGP: [Detail
Instruction](https://www.apache.org/licenses/contributor-agreements.html#submitting).
+4. Send your icla.pdf (and icla.pdf.asc if PGP-signed) to
[[email protected]](mailto:[email protected]).
+
+After waiting for some time, you will receive an email notifying you that your
CLA has been successfully recorded.
+
+## Setup ASF Account
+
+When receive an email with the subject "Welcome to the Apache Software
Foundation" from [email protected], we can begin setting up ASF account.
+
+### Setup LDAP Password
+
+1. Go to https://id.apache.org/reset/enter and enter your ApacheID.
+2. Check your email and click the provided link to reset your password.
+
+### Link ASF Account to GitHub
+
+1. Navigate to https://gitbox.apache.org/boxer/ and enter your ApacheID and
password.
+2. Click "Authenticate with GitHub" and follow the given instructions to link
your ASF account to GitHub.
+3. Check your email titled "[GitHub] @asfgit has invited you to join the
@apache organization" and accept the invitation.
+4. Wait momentarily, and the website will refresh on its own.
+5. (If you not enable 2FA on GitHub) Please follow the
[instruction](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication).
+
+Your ApacheID and GitHub ID will now both appear on
https://gitbox.apache.org/boxer/. Congrats on successfully linking your ASF
account to GitHub!
+
+## Email Settings
+
+Note: Apache does not provide a mailbox directly.
+
+### Receive Email
+
+You can change your forwarding email address at [Apache Account Utility
Platform](https://id.apache.org/)
+
+### Send Email
+
+To send emails using your apache.org address, configure your email client to
leverage the `mail-relay` service. For specifics, refer to [this
guide](https://infra.apache.org/committer-email.html).
+
+Here's an illustration for Gmail users:
+
+1. Open Gmail settings and select "See all settings".
+2. Navigate to "Accounts and Import", then locate "Send mail as".
+3. Click "Add another email address" and enter your name and apache.org email
address.
+4. Input the SMTP server information:
+ - SMTP Server: mail-relay.apache.org
+ - Port: 587
+ - Username: your apacheID
+ - Password: your apacheID password
+ - Secured connection using TLS
+5. Click "Add account" and you will receive an email from Gmail that need to
confirm.
+
+
+
+### Subscribe Mailing List
+
+1. Send email to
[[email protected]](mailto:[email protected])
+2. You will receive an email with the subject "confirm subscribe to
[email protected]"
+3. Reply to the email with "Confirm" in the body
+
+If you receive an email with the subject "WELCOME to [email protected]",
you have successfully subscribed to the mailing list.
+
+## Setup 1password
+OpenDAL offers a 1password open source team license for conducting local
integration tests (Thanks to 1Password!). Once you have been added to OpenDAL's
committer list, one of the PPMC members will invite you to join the team.
+
+Please download your preferred clients to begin using it. Here are some
important notes regarding the use of 1Password:
+
+- You can create your own vault that is accessible only by yourself. Neither
the 1password team nor OpenDAL PPMC members can access it unless you choose to
share it.
+- Please refrain from modifying secrets in the `Services` vault as this could
disrupt our integration tests.
+- Ensure that you keep all secrets secure and avoid sharing them with others
or making them public. Do not commit them anywhere else.
diff --git a/website/docs/contributing/gmail-smtp-setting.jpg
b/website/docs/contributing/gmail-smtp-setting.jpg
new file mode 100644
index 000000000..6b5645a96
Binary files /dev/null and b/website/docs/contributing/gmail-smtp-setting.jpg
differ
