Skip to content

Commit

Permalink
docs: add maturity model check (#3680)
Browse files Browse the repository at this point in the history
  • Loading branch information
suyanhanx authored Dec 3, 2023
1 parent e4734cd commit 75f7b27
Show file tree
Hide file tree
Showing 7 changed files with 178 additions and 9 deletions.
13 changes: 7 additions & 6 deletions website/community/committers/committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ 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.
Upon receiving an invitation email from OpenDAL's PPMC, a new committer should consider whether accepting.
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
3. Sign the 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).
Expand All @@ -23,7 +24,7 @@ After waiting for some time, you will receive an email notifying you that your C

## 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.
When receiving an email with the subject "Welcome to the Apache Software Foundation" from [email protected], we can begin setting up an ASF account.

### Setup LDAP Password

Expand All @@ -36,7 +37,7 @@ When receive an email with the subject "Welcome to the Apache Software Foundatio
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).
5. (If you do 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!

Expand Down Expand Up @@ -67,7 +68,7 @@ Here's an illustration for Gmail users:

![Gmail Settings](gmail-smtp-setting.jpg)

### Subscribe Mailing List
### Subscribe to 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]"
Expand All @@ -77,7 +78,7 @@ If you receive an email with the subject "WELCOME to [email protected]", yo

## 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.
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:

Expand Down
13 changes: 10 additions & 3 deletions website/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Every volunteer project obtains its strength from the people involved in it. We

You can:

* Use our project and provide a feedback.
* Use our project and provide feedback.
* Provide us with the use-cases.
* Report bugs and submit patches.
* Contribute code, documentation.
Expand Down Expand Up @@ -37,14 +37,14 @@ If you email us with a code snippet, make sure that:

* you do not link to files in external services as such files can change, get deleted or the link might break and thus make an archived email thread useless
* you paste text instead of screenshots of text
* you keep formatting when pasting code in order to keep the code readable
* you keep formatting when pasting code to keep the code readable
* there are enough import statements to avoid ambiguities

## Issue tracker

We use GitHub Issues to track all code related issues: https://github.com/apache/incubator-opendal/issues

You must have a [GitHub account](https://github.com/signup) in order to log cases and issues.
You must have a [GitHub account](https://github.com/signup) to log cases and issues.

### Bug reports

Expand All @@ -63,3 +63,10 @@ Enhancements or new feature proposals are also welcome. The more concrete and ra
## Source code

* OpenDAL core repository: https://github.com/apache/incubator-opendal

## People
The list below could be outdated. Please find the most up-to-date list [here](https://people.apache.org/phonebook.html?podling=opendal).

import Committers from "../src/components/Committers"

<Committers/>
17 changes: 17 additions & 0 deletions website/community/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Security
---

# Security

The Apache Software Foundation takes a rigorous stance on eliminating security issues in its software projects. Likewise, Apache OpenDAL is also vigilant and takes security issues related to its features and functionality into the highest consideration.

If you have any concerns regarding OpenDAL's security,
or you discover a vulnerability or potential threat,
please do not hesitate to get in touch with the Apache Security Team by dropping an email at [email protected].

Please specify the project name as "OpenDAL" in the email, and provide a description of the relevant problem or potential threat. You are also urged to recommend how to reproduce and replicate the issue.

The Apache Security Team and the OpenDAL community will get back to you after assessing and analyzing the findings.

Please note that the security issue should be reported on the security email first, before disclosing it on any public domain.
5 changes: 5 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,11 @@ const config = {
darkTheme: darkCodeTheme,
additionalLanguages: ['rust', 'java', 'groovy'],
},
zoom: {
selector: '.markdown img',
background: 'rgba(255, 255, 255, 0.8)',
config: {}
}
}),
};

Expand Down
Loading

0 comments on commit 75f7b27

Please sign in to comment.