You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by ww...@apache.org on 2022/01/28 17:24:53 UTC

[incubator-yunikorn-site] branch master updated: [YUNIKORN-1045] add maturity assessment matrix (#118)

This is an automated email from the ASF dual-hosted git repository.

wwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 19dbf9c  [YUNIKORN-1045] add maturity assessment matrix (#118)
19dbf9c is described below

commit 19dbf9c6bdd6e21c707cb5e2fdb7f58ade5052de
Author: Wilfred Spiegelenburg <wi...@apache.org>
AuthorDate: Sat Jan 29 04:24:45 2022 +1100

    [YUNIKORN-1045] add maturity assessment matrix (#118)
    
    The maturity matrix is only added in English with a placeholder for the locale zh-cn pointing back to the English version.
    
    Use docusaurus beta 15 consistently, not just the search integration.
---
 docusaurus.config.js                               |  4 ++
 .../community/maturity.md                          | 27 ++++++++
 i18n/zh-cn/docusaurus-theme-classic/navbar.json    |  5 +-
 package.json                                       |  4 +-
 src/pages/community/maturity.md                    | 76 ++++++++++++++++++++++
 5 files changed, 113 insertions(+), 3 deletions(-)

diff --git a/docusaurus.config.js b/docusaurus.config.js
index af547a4..ca6305c 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -114,6 +114,10 @@ module.exports = {
               to: 'community/people',
               label: 'People',
             },
+            {
+              to: 'community/maturity',
+              label: 'Incubation Maturity Assessment',
+            },
           ]
         },
         {
diff --git a/i18n/zh-cn/docusaurus-plugin-content-pages/community/maturity.md b/i18n/zh-cn/docusaurus-plugin-content-pages/community/maturity.md
new file mode 100644
index 0000000..39ba161
--- /dev/null
+++ b/i18n/zh-cn/docusaurus-plugin-content-pages/community/maturity.md
@@ -0,0 +1,27 @@
+---
+id: maturity
+title: Apache 成熟度模型
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+Apache YuniKorn (Incubating) 成熟度自我評估
+
+本文檔僅提供英文版本
diff --git a/i18n/zh-cn/docusaurus-theme-classic/navbar.json b/i18n/zh-cn/docusaurus-theme-classic/navbar.json
index bef014f..e245170 100644
--- a/i18n/zh-cn/docusaurus-theme-classic/navbar.json
+++ b/i18n/zh-cn/docusaurus-theme-classic/navbar.json
@@ -14,6 +14,9 @@
     "item.label.People": {
         "message": "人员"
     },
+    "item.label.Incubation Maturity Assessment": {
+        "message": "成熟度自我评估"
+    },
     "item.label.Get Involved": {
         "message": "进行参与"
     },    
@@ -44,4 +47,4 @@
     "item.label.Sponsors": {
         "message": "赞助商"
     }
-}
\ No newline at end of file
+}
diff --git a/package.json b/package.json
index 1e901df..8d94c5f 100644
--- a/package.json
+++ b/package.json
@@ -10,8 +10,8 @@
     "release": "docusaurus docs:version"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.14",
-    "@docusaurus/preset-classic": "2.0.0-beta.14",
+    "@docusaurus/core": "^2.0.0-beta.15",
+    "@docusaurus/preset-classic": "^2.0.0-beta.15",
     "@docusaurus/theme-search-algolia": "^2.0.0-beta.15",
     "@mdx-js/react": "^1.5.8",
     "clsx": "^1.1.1",
diff --git a/src/pages/community/maturity.md b/src/pages/community/maturity.md
new file mode 100644
index 0000000..01892ce
--- /dev/null
+++ b/src/pages/community/maturity.md
@@ -0,0 +1,76 @@
+---
+id: maturity
+title: Apache Maturity Model
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+## Apache YuniKorn (Incubating) Maturity self assessment
+
+This is an assessment of the maturity of Apache YuniKorn (Incubating) as an Apache project.
+It is intended to inform the decision (of mentors, community, incubator PMC and ASF Board of Directors) to graduate YuniKorn as a top-level Apache project.
+It is based on the [ASF project maturity model](https://community.apache.org/apache-way/apache-project-maturity-model.html).
+
+### Maturity Model Assessment
+Mentors and community members are encouraged to contribute to this page and comment on it, the following table summarizes project’s self-assessment against the Apache Maturity Model.
+
+| ID   | Description                                                                                                                                                                                                                                                    | Status                                                                                                                                                                                                                             [...]
+|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
+| CD10 | The project produces Open Source software for distribution to the public, at no charge.                                                                                                                                                                        | The project source code is licensed under the Apache License, version 2.0.                                                                                                                                                         [...]
+| CD20 | Anyone can easily discover and access the project’s code.                                                                                                                                                                                                      | The source code is available from a set of git repositories, linked from the YuniKorn website.                                                                                                                                     [...]
+| CD30 | Anyone using standard, widely-available tools, can build the code in a reproducible way.                                                                                                                                                                       | The source code is automatically built for each Pull Request commit, with license checks, unit and end to end tests, via GitHub actions. Development environment setup and build instructions to do the same locally are documente [...]
+| CD40 | The full history of the project’s code is available via a source code control system, in a way that allows anyone to recreate any released version.                                                                                                            | The commit history is available from the beginning of the project. All releases that have been made during the incubation period are tagged in the repository.                                                                     [...]
+| CD50 | The source code control system establishes the provenance of each line of code in a reliable way, based on strong authentication of the committer. When third parties contribute code, commit messages provide reliable information about the code provenance. | The project uses multiple git repositories, all managed by Apache Infra, ensuring provenance of each line of code to a committer. All code is checked in after review and approval of a GitHub pull-request.                       [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| LC10 | The Apache License, version 2.0, covers the released code.                                                                                                                                                                                                     | Source distributions clearly states the license. Docker images are clearly licensed.                                                                                                                                               [...]
+| LC20 | Libraries that are mandatory dependencies of the project’s code do not create more restrictions than the Apache License does.                                                                                                                                  | The list of mandatory dependencies have been reviewed to contain approved licenses only.                                                                                                                                           [...]
+| LC30 | The libraries mentioned in LC20 are available as Open Source software                                                                                                                                                                                          | All mandatory dependencies are available as open source software.                                                                                                                                                                  [...]
+| LC40 | Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they may commit and how they need to identify code that is not their own.                                                                              | The project uses a repository managed by Apache Infra, write access requires an Apache account, which requires an ICLA on file.                                                                                                    [...]
+| LC50 | The project clearly defines and documents the copyright ownership of everything that the project produces.                                                                                                                                                     | All files in the source repository have appropriate headers. An automated process as part of the pre-commit workflow is in place to ensure every file has the expected license header.                                             [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| RE10 | Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term.                                                                                                                      | Recent releases are available via the download page on the website. All releases are available via the archive https://archive.apache.org/dist/incubator/yunikorn/. Source code and docker images are linked to from the website.  [...]
+| RE20 | The project’s PMC (Project Management Committee, see CS10) approves each software release in order to make the release an act of the Foundation.                                                                                                               | All incubating releases have been approved by the YuniKorn community and the Incubator, all with at least 3 (P)PMC votes and more +1 than -1.                                                                                      [...]
+| RE30 | Releases are signed and/or distributed along with digests that anyone can reliably use to validate the downloaded archives.                                                                                                                                    | Releases are signed, the keys are available from the YuniKorn download page. Every release has a SHA-512 checksum to prevent content tampering.                                                                                    [...]
+| RE40 | The project can distribute convenience binaries alongside source code, but they are not Apache Releases, they are provided with no guarantee.                                                                                                                  | Docker images are available from Dockerhub under the Apache account.                                                                                                                                                               [...]
+| RE50 | The project documents a repeatable release process so that someone new to the project can independently generate the complete set of artifacts required for a release.                                                                                         | The processes to create and check a release are documented. The release process is almost fully automated. Each of the five releases made so far during the incubation period has used a different release manager.                [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| QU10 | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated.                                                                  | Open issues are listed in the public Jira and discussed in JIRA, on chat and the mailing list.                                                                                                                                     [...]
+| QU20 | The project puts a very high priority on producing secure software.                                                                                                                                                                                            | Security issues are treated with the highest priority. We use Apache's default way to submit security related information.                                                                                                         [...]
+| QU30 | The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them.                                                                                                               | The process to report a security issue is documented on the website: https://yunikorn.apache.org/community/how_to_contribute#report-a-security-issue.                                                                              [...]
+| QU40 | The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features.                                                                        | Each release contains a "Release Announcement" on the website containing the release notes (extracted from Jira). The project aims to make no backward incompatible changes within a given major version.                          [...]
+| QU50 | The project strives to respond to documented bug reports in a timely manner.                                                                                                                                                                                   | The community is very active in responding to bug reports and usually fixes them within a short time period.                                                                                                                       [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| CO10 | The project has a well-known homepage that points to all the information required to operate according to this maturity model.                                                                                                                                 | The website describes the project and contains links to all relevant systems (e.g., issue tracker, source repositories, mailing lists and chat channel).                                                                           [...]
+| CO20 | The community welcomes contributions from anyone who acts in good faith and in a respectful manner, and who adds value to the project.                                                                                                                         | Committers are really welcome contributions and the community is actively seeking for new committers.                                                                                                                              [...]
+| CO30 | Contributions include source code, documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project.                                                                                         | The community welcomes all contributions, e.g., also documentation translation or website improvements, and is very clear about contributions being more than code.                                                                [...]
+| CO40 | The community strives to be meritocratic and gives more rights and responsibilities to contributors who, over time, add value to the project.                                                                                                                  | 2 new mentors, 8 new committers, 4 new PPMC members from 6 different organizations have been elected during the incubation phase.                                                                                                  [...]
+| CO50 | The project documents how contributors can earn more rights such as commit access or decision power, and applies these principles consistently.                                                                                                                | The process to become a committer or PPMC member is documented on the website.                                                                                                                                                     [...]
+| CO60 | The community operates based on consensus of its members (see CS10) who have decision power. Dictators, benevolent or not, are not welcome in Apache projects.                                                                                                 | The project works to build consensus. All PPMC votes have been unanimous so far.                                                                                                                                                   [...]
+| CO70 | The project strives to answer user questions in a timely manner.                                                                                                                                                                                               | Responses to reported issues or asked questions typically are handled by the community withing a matter of a few hours.                                                                                                            [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| CS10 | The project maintains a public list of its contributors who have decision power. The project’s PMC (Project Management Committee) consists of those contributors.                                                                                              | Committers and PPMC members are listed on the website’s community page https://yunikorn.apache.org/community/people.                                                                                                               [...]
+| CS20 | Decisions require a consensus among PMC members and are documented on the project’s main communications channel. The PMC takes community opinions into account, but the PMC has the final word.                                                                | All important decisions were made by consensus on the mailing list.                                                                                                                                                                [...]
+| CS30 | The project uses documented voting rules to build consensus when discussion is not sufficient.                                                                                                                                                                 | The project uses the standard ASF voting rules.                                                                                                                                                                                    [...]
+| CS40 | In Apache projects, vetoes are only valid for code commits. The person exercising the veto must justify it with a technical explanation, as per the Apache voting rules defined in CS30.                                                                       | The project has not used a veto at any point during incubation.                                                                                                                                                                    [...]
+| CS50 | All "important" discussions happen asynchronously in written form on the project’s main communications channel. Offline, face-to-face or private discussions 11 that affect the project are also documented on that channel.                                   | The main communication channel is the mailing list. There are other channels, such as the chat channel, which are not used for important project discussions.                                                                      [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]
+| IN10 | The project is independent from any corporate or organizational influence.                                                                                                                                                                                     | The committers and PPMC members are a group of passionate people from at least 14 different organizations.                                                                                                                         [...]
+| IN20 | Contributors act as themselves, not as representatives of a corporation or organization.                                                                                                                                                                       | The contributors act on their own initiative without representing a corporation or organization.                                                                                                                                   [...]
+|      |                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                    [...]