This is an automated email from the ASF dual-hosted git repository.
weibin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-graphar-website.git
The following commit(s) were added to refs/heads/main by this push:
new 7229ac9 Add community message (#9)
7229ac9 is described below
commit 7229ac9941dd8863144e3d86a7361e83fecc86bc
Author: Weibin Zeng <[email protected]>
AuthorDate: Thu Apr 11 00:38:49 2024 +0800
Add community message (#9)
---
community/committers/_category_.yml | 23 ++++
community/committers/reference/_category_.yml | 25 ++++
.../committers/reference/generate_release_note.md | 12 ++
community/committers/release.md | 142 +++++++++++++++++++++
community/index.md | 108 ++++++++++++++++
community/sidebars.ts | 42 ++++++
docusaurus.config.ts | 21 +++
7 files changed, 373 insertions(+)
diff --git a/community/committers/_category_.yml
b/community/committers/_category_.yml
new file mode 100644
index 0000000..7bc2f69
--- /dev/null
+++ b/community/committers/_category_.yml
@@ -0,0 +1,23 @@
+# 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.
+
+position: 1
+label: 'Committers'
+collapsible: true
+collapsed: false
+link:
+ type: generated-index
\ No newline at end of file
diff --git a/community/committers/reference/_category_.yml
b/community/committers/reference/_category_.yml
new file mode 100644
index 0000000..8556c40
--- /dev/null
+++ b/community/committers/reference/_category_.yml
@@ -0,0 +1,25 @@
+
+# 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.
+
+position: 100
+label: 'Reference'
+collapsible: true
+collapsed: true
+link:
+ type: generated-index
+ title: Reference
diff --git a/community/committers/reference/generate_release_note.md
b/community/committers/reference/generate_release_note.md
new file mode 100644
index 0000000..03519ac
--- /dev/null
+++ b/community/committers/reference/generate_release_note.md
@@ -0,0 +1,12 @@
+---
+title: Generate release note
+---
+
+This document describes how to generate release notes using GitHub:
+
+1. Go to https://github.com/apache/incubator-graphar/releases/new to start a
new release.
+2. Fill the tag with `draft`.
+3. Click on `Generate release notes` to generate them.
+4. Copy the generated content and close the page.
+
+Please note that we only use this feature to generate release notes, so please
do not click on `Publish Release` or `Save draft`. We will publish it after
creating the tag.
diff --git a/community/committers/release.md b/community/committers/release.md
new file mode 100644
index 0000000..cc59ab8
--- /dev/null
+++ b/community/committers/release.md
@@ -0,0 +1,142 @@
+---
+title: Create a release (Work in Progress)
+sidebar_position: 1
+---
+
+This document mainly introduces how the release manager
+releases a new version of Apache GraphAr in accordance with the Apache
requirements.
+
+## Introduction
+
+`Source Release` is the key point which Apache values, and is also necessary
for an ASF release.
+
+Please remember that publishing software has legal consequences.
+
+This guide complements the foundation-wide policies and guides:
+
+- [Release Policy](https://www.apache.org/legal/release-policy.html)
+- [Release Distribution Policy](https://infra.apache.org/release-distribution)
+- [Release Creation Process](https://infra.apache.org/release-publishing.html)
+
+## Some Terminology of release
+
+In the context of our release, we use several terms to describe different
stages of the release process.
+
+Here's an explanation of these terms:
+
+- `graphar_version`: the version of GraphAr to be released, like `0.12.0`.
+- `release_version`: the version of release candidate, like `0.12.0-rc.1`.
+- `rc_version`: the minor version for voting round, like `rc.1`.
+
+## Preparation
+
+:::caution
+
+This section is the requirements for individuals who are new to the role of
release manager.
+
+:::
+
+## Start discussion about the next release
+
+Start a discussion about the next release via sending email to:
[email protected]:
+
+Title:
+
+```
+[DISCUSS] Release Apache GraphAr(incubating) ${release_version}
+```
+
+Content:
+
+```
+Hello, Apache GraphAr(incubating) Community,
+
+This is a call for a discussion to release Apache GraphAr(incubating) version
${graphar_version}.
+
+The change lists about this release:
+
+https://github.com/apache/incubator-graphar/compare/v${graphar_last_version}...main
+
+Please leave your comments here about this release plan. We will bump the
version in the repo and start the release process after the discussion.
+
+Thanks
+
+${name}
+```
+
+## Start a tracking issue about the next release
+
+Start a tracking issue on GitHub for the upcoming release to track all tasks
that need to be completed.
+
+Title:
+
+```
+Tracking issues of GraphAr ${graphar_version} Release
+```
+
+Content:
+
+```markdown
+This issue is used to track tasks of the graphar ${graphar_version} release.
+
+## Tasks
+
+### Blockers
+
+> Blockers are the tasks that must be completed before the release.
+
+### Build Release
+
+#### GitHub Side
+
+- [ ] Bump version in project
+ - [ ] cpp
+ - [ ] java
+ - [ ] spark
+ - [ ] pyspark
+- [ ] Update docs
+- [ ] Generate dependencies list
+- [ ] Push release candidate tag to GitHub
+
+#### ASF Side
+
+- [ ] Create an ASF Release
+- [ ] Upload artifacts to the SVN dist repo
+- [ ] Close the Nexus staging repo
+
+### Voting
+
+- [ ] Start VOTE at graphar community
+- [ ] Start VOTE at incubator community
+
+### Official Release
+
+- [ ] Push the release git tag
+- [ ] Publish artifacts to SVN RELEASE branch
+- [ ] Change GraphAr Website download link
+- [ ] Release Maven artifacts
+- [ ] Send the announcement
+
+For details of each step, please refer to:
https://graphar.apache.org/community/committers/release
+```
+
+## GitHub Side
+
+### Bump version in project
+
+Bump all components' version in the project to the new graphar version.
+Please note that this version is the exact version of the release, not the
release candidate version.
+
+- cpp library: bump version in `cpp/CMakeLists.txt`
+- java library: bump version in `java/pom.xml`
+- spark library: bump version in `spark/pom.xml`
+- pyspark library: bump version in `pyspark/poetry.toml`
+
+### Update docs
+
+### Push release candidate tag
+
+After bump version PR gets merged, we can create a GitHub release for the
release candidate:
+
+- Create a tag at `main` branch on the `Bump Version` / `Patch up version`
commit: `git tag -s "v0.12.0-rc.1"`, please correctly check out the
corresponding commit instead of directly tagging on the main branch.
+- Push tags to GitHub: `git push --tags`.
diff --git a/community/index.md b/community/index.md
new file mode 100644
index 0000000..ad6a2d4
--- /dev/null
+++ b/community/index.md
@@ -0,0 +1,108 @@
+---
+id: community
+title: Community
+sidebar_position: 1
+---
+
+Welcome to the Apache GraphAr community!
+
+Every volunteer project obtains its strength from the people involved in it.
We invite you to participate as much or as little as you choose.
+
+You can:
+
+* Use our project and provide feedback.
+* Provide us with the use-cases.
+* Report bugs and submit patches.
+* Contribute code, documentation.
+
+## Mailing list
+
+| Name | Desc | Subscribe
| Unsubscribe
| Post | Archive
|
+|----------------------------|---------------------------------|----------------------------------------------------------|--------------------------------------------------------------|----------------------------------------|--------------------------------------------------------------------------|
+| [email protected] | Development related discussions |
[Subscribe](mailto:[email protected]) |
[Unsubscribe](mailto:[email protected]) |
[Post](mailto:[email protected]) |
[Archive](https://lists.apache.org/[email protected]) |
+| [email protected] | All commits to our repositories |
[Subscribe](mailto:[email protected]) |
[Unsubscribe](mailto:[email protected]) | Read only list
|
[Archive](https://lists.apache.org/[email protected]) |
+
+
+Please make sure you are subscribed to the mailing list you are posting to!
+
+If you are not subscribed to the mailing list, your message will either be
rejected or you won't receive the response.
+
+### How to subscribe to a mailing list
+
+Before you can post a message to a mailing list, you need to subscribe to the
list first.
+
+1. Send an email without any contents or subject to
[email protected]. (replace listname with dev or user)
+2. Wait till you receive an email with the subject "confirm subscribe to
[email protected]". Reply to that email, without editing the subject
or including any contents.
+3. Wait till you receive an email with the subject "WELCOME to
[email protected]".
+
+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 to keep the code readable
+* there are enough import statements to avoid ambiguities
+
+### Tag Convention
+
+The mailing list follow the convention of prefixing subjects with one or more
tags in order to
+clarify the scope and purpose of messages. For example:
+
+- [ANNOUNCE] GraphAr 0.1.0 released
+- [DISCUSS][C++] How to implement a new API in C++?
+- [DISCUSS][Format] How to support partition pruning?
+- [Spark][Reader] Support the push-down of filters
+
+When emailing to the mail list, please prefix the subject line with one or
more tags.
+Depending the topic of your email, tags may include one or more:
+
+- Supported Environments: e.g., [C++], [Spark], [Java], etc.
+- Specifications: e.g., [Format], [Reader], [Writer], [API], etc.
+
+You may also prefix your subject line with [DISCUSS] if your email is intended
to prompt a discussion
+rather than get an answer to a specific question.
+
+## Issue tracker
+
+We use GitHub Issues to track all code related issues:
https://github.com/apache/incubator-graphar/issues
+
+You must have a [GitHub account](https://github.com/signup) to log cases and
issues.
+
+### Bug reports
+
+Found bug? Enter an issue in the issue tracker.
+
+Before submitting an issue, please:
+
+* Verify that the bug does in fact exist.
+* Search the issue tracker to verify there is no existing issue reporting the
bug you've found.
+* Consider tracking down the bug yourself in the source code of GraphAr and
submitting a patch along with your bug report. This is a great time saver for
the GraphAr developers and helps ensure the bug will be fixed quickly.
+
+### Enhancement
+
+Enhancements or new feature proposals are also welcome. The more concrete and
rationale the proposal is, the greater the chance it will be incorporated into
future releases.
+
+## Source code
+
+* GraphAr core repository: https://github.com/apache/graphar
+
+## Community Meeting
+
+We host a online meeting to provide spaces for synchronous discussions about
the GraphAr project.
+During the meeting, we will cover various topics including project status,
roadmap updates, and other relevant discussions.
+
+The community meeting runs weekly, every Tuesday at 7:00 PM (UTC+8).
+
+See the [community meeting
notes](https://github.com/apache/incubator-graphar/wiki/GraphAr-Weekly-Community-Meeting)
for the next meeting.
+
+For now, we have a single community event known as the Community Sync Meeting.
+This meeting is open to everyone.
+
+## People
+
+Thank you to all the contributors for your selfless dedication and expertise
+in making this project more comprehensive and valuable.
+We sincerely appreciate your support and efforts!
+
+### Contributors
+
+The contributor list could be found
[here](https://github.com/apache/graphar/graphs/contributors/).
diff --git a/community/sidebars.ts b/community/sidebars.ts
new file mode 100644
index 0000000..50abd51
--- /dev/null
+++ b/community/sidebars.ts
@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+// Check https://docusaurus.io/docs/sidebar/ for more information.
+const sidebars: SidebarsConfig = {
+ // By default, Docusaurus generates a sidebar from the docs folder structure
+ // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+ docs: [{type: 'autogenerated', dirName: '.'}],
+
+ // But you can create a sidebar manually
+ /*
+ tutorialSidebar: [
+ 'intro',
+ 'hello',
+ {
+ type: 'category',
+ label: 'Tutorial',
+ items: ['tutorial-basics/create-a-document'],
+ },
+ ],
+ */
+};
+
+export default sidebars;
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index cb00333..92eb8d2 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -49,6 +49,7 @@ const config: Config = {
docs: {
sidebarPath: './docs/sidebars.ts',
editUrl: `https://github.com/apache/${siteRepoName}/tree/main/`,
+ exclude: ['**/README.md'],
},
blog: {
blogSidebarCount: 'ALL',
@@ -63,6 +64,19 @@ const config: Config = {
],
],
+ plugins: [
+ [
+ 'content-docs',
+ {
+ id: 'community',
+ path: 'community',
+ routeBasePath: 'community',
+ sidebarPath: require.resolve('./community/sidebars.ts'),
+ editUrl: `https://github.com/apache/${siteRepoName}/tree/main/`,
+ },
+ ],
+ ],
+
themeConfig: {
// TODO: Replace with your project's social card
image: 'img/social-card.png',
@@ -78,6 +92,13 @@ const config: Config = {
position: 'right',
label: 'Documentation',
},
+ {
+ type: 'doc',
+ docId: 'community',
+ position: 'right',
+ label: 'Community',
+ docsPluginId: 'community'
+ },
{ to: '/blog', label: 'Blog', position: 'right' },
{
type: 'dropdown',
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
