This is an automated email from the ASF dual-hosted git repository. djwang pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/cloudberry-site.git
commit 1bff351d3595b081261f954c511100114d14a4e9 Author: Dianjin Wang <[email protected]> AuthorDate: Thu Nov 28 16:19:39 2024 +0800 Rename and clean unnecessary files for pages Update the links and project name on the following related pages: * Bootcamp * Community * Contribute * Support At the same time, remove the files coc.md and security.md from site as we use the ASF policy documents. --- src/consts/bootcamp.tsx | 197 +++--------------------- src/consts/community.tsx | 26 ++-- src/consts/contribute.tsx | 87 +---------- src/consts/homeContent.tsx | 21 ++- src/consts/support.tsx | 240 ++---------------------------- src/pages/community/coc.md | 134 ----------------- src/pages/community/events.md | 2 +- src/pages/community/security.md | 69 --------- src/pages/community/slack.md | 19 ++- src/pages/community/wechat.md | 7 +- src/pages/contribute/code.md | 80 ++++------ src/pages/contribute/doc.md | 31 ++-- src/pages/contribute/git.md | 72 ++------- src/pages/contribute/how-to-contribute.md | 24 +-- src/pages/contribute/proposal.md | 44 +++--- src/theme/Footer/index.tsx | 6 - 16 files changed, 157 insertions(+), 902 deletions(-) diff --git a/src/consts/bootcamp.tsx b/src/consts/bootcamp.tsx index b246b0a1..6a5673ba 100644 --- a/src/consts/bootcamp.tsx +++ b/src/consts/bootcamp.tsx @@ -3,35 +3,35 @@ import { formatStrHorizontalLine, isZhLangrage } from "../utils"; let BOOTCAMP_PAGE_CONFIG = { headerCard: { - titleText: "Cloudberry Database Bootcamp", + titleText: "Apache Cloudberry Bootcamp", subText: - "Join us on an exciting journey to explore the features of Cloudberry Database using a Docker engine-based sandbox. Get ready to elevate your database skills. Happy exploring!", + "Join us on an exciting journey to explore the features of Cloudberry using a Docker engine-based sandbox. Get ready to elevate your database skills. Happy exploring!", }, DATA_0: { title: "Bootcamp Outline", - subTitle: "CloudberryDB Sandbox", + subTitle: "Cloudberry Sandbox", card: { content: - "This document guides you on how to quickly set up and connect to a single-node Cloudberry Database in a Docker environment. You can try out Cloudberry Database by performing some basic operations and running SQL commands.", + "This document guides you on how to quickly set up and connect to a single-node Cloudberry in a Docker environment. You can try out Cloudberry by performing some basic operations and running SQL commands.", link: { text: "Create your Sandox", href: "/bootcamp/cbdb-sandbox" }, }, }, DATA_101: { - title: "101-CloudberryDB Tourials", + title: "101-Cloudberry Tourials", subText: ( <> - This part contains a series of tutorials for quickly String out - Cloudberry Database based on the CloudberryDB Sandbox. Before starting + This part contains a series of tutorials for quickly trying out + Cloudberry based on the Cloudberry Sandbox. Before starting to read the tutorials, you are expected to finish installing the single-node Cloudberry Database by following the{" "} - <span className="active-color">CloudberryDB Sandbox</span>. + <span className="active-color">Cloudberry Sandbox</span>. </> ), cardLine1: [ { title: "Lesson 0", link: { - text: "Introduction to Database and CloudberryDB Architecture", + text: "Introduction to Database and Cloudberry Architecture", href: "/bootcamp/101-0-introduction-to-database-and-cloudberrydb-architecture", }, style: { width: 221 }, @@ -87,20 +87,20 @@ let BOOTCAMP_PAGE_CONFIG = { ], }, DATA_102: { - title: "102-CloudberryDB Crash Course", + title: "102-Cloudberry Crash Course", card: { link: { text: "Click to start", href: "/bootcamp/102-cbdb-crash-course", }, content: - "This crash course provides an extensive overview of Cloudberry Database, an open-source Massively Parallel Processing (MPP) database. It covers key concepts, features, utilities, and hands-on exercises to become proficient with CBDB.", + "This crash course provides an extensive overview of Cloudberry, an open-source Massively Parallel Processing (MPP) database. It covers key concepts, features, utilities, and hands-on exercises to become proficient with Cloudberry.", }, }, DATA_103: { - title: "103-CloudberryDB Performance Benchmark", - subText: `This tutorial will show you how to perform a CloudberryDB performance - benchmark in the CloudberryDB Sandbox Docker image. The benchmark + title: "103-Cloudberry Performance Benchmark", + subText: `This tutorial will show you how to perform a Cloudberry performance + benchmark in the Cloudberry Sandbox Docker image. The benchmark process consists of two parts:`, cardLine: [ { @@ -122,13 +122,13 @@ let BOOTCAMP_PAGE_CONFIG = { ], }, DATA_104: { - title: "104-CloudberryDB for Data Science", + title: "104-Cloudberry for Data Science", cardLine: [ { title: "104-1", style: { width: 474 }, link: { - text: "Introduction to CloudberryDB In-Database Analytics", + text: "Introduction to Cloudberry In-Database Analytics", href: "/bootcamp/104-1-introduction-to-cloudberrydb-in-database-analytics", }, }, @@ -148,10 +148,10 @@ let BOOTCAMP_PAGE_CONFIG = { <> You can get the whole Bootcamp source code from the GitHub repo{" "} <LinkWithBaseUrl - to="https://github.com/cloudberrydb/bootcamp"; + to="https://github.com/apache/cloudberry-bootcamp"; className="active-color" > - cloudberrydb/bootcamp + apache/cloudberry-bootcamp </LinkWithBaseUrl> . </> @@ -159,167 +159,6 @@ let BOOTCAMP_PAGE_CONFIG = { }, }; -// zh language -if (isZhLangrage()) { - BOOTCAMP_PAGE_CONFIG = { - headerCard: { - titleText: "Cloudberry Database Bootcamp", - subText: - "Join us on an exciting journey to explore the features of Cloudberry Database using a Docker engine-based sandbox. Get ready to elevate your database skills. Happy exploring!", - }, - DATA_0: { - title: "Bootcamp Outline", - subTitle: "CloudberryDB Sandbox", - card: { - content: - "This document guides you on how to quickly set up and connect to a single-node Cloudberry Database in a Docker environment. You can try out Cloudberry Database by performing some basic operations and running SQL commands.", - link: { text: "Create your Sandox", href: "/bootcamp/cbdb-sandbox" }, - }, - }, - DATA_101: { - title: "101-CloudberryDB Tourials", - subText: ( - <> - This part contains a series of tutorials for quickly String out - Cloudberry Database based on the CloudberryDB Sandbox. Before starting - to read the tutorials, you are expected to finish installing the - single-node Cloudberry Database by following the{" "} - <span className="active-color">CloudberryDB Sandbox</span>. - </> - ), - cardLine1: [ - { - title: "Lesson 0", - link: { - text: "Introduction to Database and CloudberryDB Architecture", - href: "/bootcamp/101-0-introduction-to-database-and-cloudberrydb-architecture", - }, - style: { width: 221 }, - }, - { - title: "Lesson 1", - link: { - text: "Create Users and Roles", - href: "/bootcamp/101-1-create-users-and-roles", - }, - style: { width: 221 }, - }, - { - title: "Lesson 2", - link: { - text: "Create and Prepare Database", - href: "/bootcamp/101-2-create-and-prepare-database", - }, - style: { width: 221 }, - }, - { - title: "Lesson 3", - link: { - text: "Create Tables", - href: "/bootcamp/101-3-create-tables", - }, - style: { width: 221 }, - }, - ], - cardLine2: [ - { - title: "Lesson 4", - link: { - text: "Create Users and Roles", - href: "/bootcamp/101-4-data-loading", - }, - style: { width: 305.33 }, - }, - { - title: "Lesson 5", - link: { - text: "Create and Prepare Database", - href: "/bootcamp/101-5-queries-and-performance-tuning", - }, - }, - { - title: "Lesson 6", - link: { - text: "Backup and Restore Operations", - href: "/bootcamp/101-6-backup-and-recovery-operations", - }, - }, - ], - }, - DATA_102: { - title: "102-CloudberryDB Crash Course", - card: { - link: { - text: "Click to start", - href: "/bootcamp/102-cbdb-crash-course", - }, - content: - "This crash course provides an extensive overview of Cloudberry Database, an open-source Massively Parallel Processing (MPP) database. It covers key concepts, features, utilities, and hands-on exercises to become proficient with CBDB.", - }, - }, - DATA_103: { - title: "103-CloudberryDB Performance Benchmark", - subText: `This tutorial will show you how to perform a CloudberryDB performance - benchmark in the CloudberryDB Sandbox Docker image. The benchmark - process consists of two parts:`, - cardLine: [ - { - title: "103-1", - style: { width: 474 }, - link: { - text: "TPC-H benchmark", - href: "/bootcamp/103-cbdb-performance-benchmark-tpch", - }, - }, - { - title: "103-2", - style: { width: 474 }, - link: { - text: "TPC-DS benchmark", - href: "/bootcamp/103-cbdb-performance-benchmark-tpcds", - }, - }, - ], - }, - DATA_104: { - title: "104-CloudberryDB for Data Science", - cardLine: [ - { - title: "104-1", - style: { width: 474 }, - link: { - text: "Introduction to CloudberryDB In-Database Analytics", - href: "/bootcamp/104-1-introduction-to-cloudberrydb-in-database-analytics", - }, - }, - { - title: "104-2", - style: { width: 474 }, - link: { - text: "HashML for Data Science", - href: "/bootcamp/104-2-hashml-for-datascience", - }, - }, - ], - }, - GET_SOURCE: { - title: "Get the Source", - content: ( - <> - You can get the whole Bootcamp source code from the GitHub repo{" "} - <LinkWithBaseUrl - to="https://github.com/cloudberrydb/bootcamp"; - className="active-color" - > - cloudberrydb/bootcamp - </LinkWithBaseUrl> - . - </> - ), - }, - }; -} - let LINK_NAV_CONFIG = Object.keys(BOOTCAMP_PAGE_CONFIG) .map((key) => { if (key === "DATA_0") { diff --git a/src/consts/community.tsx b/src/consts/community.tsx index f7736cf5..46d2a8a3 100644 --- a/src/consts/community.tsx +++ b/src/consts/community.tsx @@ -33,7 +33,7 @@ let COMMUNITY_PAGE: CommunityPageConfig = { headerCard: { titleText: "We're the community because of you. Be part of us now.", subText: - "Cloudberry Database is maintained actively by a group of database experts by individuals and companies. We believe in the power of open source way and community. Explore ways to get involved, and stay up-to-date with the latest announcements and events.", + "Apache Cloudberry is maintained actively by a group of database experts by individuals and companies. We believe in the power of open source way and community. Explore ways to get involved, and stay up-to-date with the latest announcements and events.", }, cardWraps: [ { @@ -78,17 +78,17 @@ let COMMUNITY_PAGE: CommunityPageConfig = { icon: <ReportBugsIcon fill={"#fff"} />, title: "Report bugs", content: - "If you find any bugs in Cloudberry Database's core, please submit them on GitHub. More eyes result in fewer bugs.", + "If you find any bugs in Apache Cloudberry's core, please submit them on GitHub. More eyes result in fewer bugs.", link: { text: "File an issue on GitHub", - href: "https://github.com/cloudberrydb/cloudberrydb/issues";, + href: "https://github.com/apache/cloudberry/issues";, }, }, { icon: <ForDevIcon fill="#fff" />, title: "Share new ideas / Make feature requests", content: - "Share your ideas and request new features on GitHub Discussions to help shape the future of the Cloudberry Database.", + "Share your ideas and request new features on GitHub Discussions to help shape the future of the Apache Cloudberry.", link: { text: "Share your ideas", href: "https://github.com/apache/cloudberry/discussions/new?category=ideas-feature-requests";, @@ -118,14 +118,14 @@ let COMMUNITY_PAGE: CommunityPageConfig = { style: { width: 474 }, title: "Documentation", content: - "The knowledge base is where you can find most of the usage and troubleshooting in the Cloudberry Database.", + "The knowledge base is where you can find most of the usage and troubleshooting in the Apache Cloudberry.", link: { text: "View the doc", href: "/docs" }, }, { style: { width: 474 }, title: "Q&A", content: - "Ask for help on GitHub Discussions when running or developing Cloudberry Database. We're always here to assist you.", + "Ask for help on GitHub Discussions when running or developing Apache Cloudberry. We're always here to assist you.", link: { text: "Ask for help", href: "https://github.com/apache/cloudberry/discussions/categories/q-a";, @@ -152,7 +152,7 @@ let COMMUNITY_PAGE: CommunityPageConfig = { title: "Twitter", style: { width: 474 }, content: - 'For news and updates, follow @cloudberrydb on Twitter("X" now).', + 'For news and updates, follow @ASFCloudberry on Twitter("X" now).', link: { text: "Follow us", href: "https://x.com/ASFCloudberry";, @@ -180,10 +180,10 @@ let COMMUNITY_PAGE: CommunityPageConfig = { { title: "Youtube", content: - "Get notified about the latest videos by subscribing to the CloudberryDB channel.", + "Get notified about the latest videos by subscribing to the Apache Cloudberry channel.", link: { text: "Watch now", - href: "https://youtube.com/@cloudberrydb";, + href: "https://youtube.com/@ApacheCloudberry";, }, }, ], @@ -200,7 +200,7 @@ let COMMUNITY_PAGE: CommunityPageConfig = { title: "Code of Conduct", content: "Work together to create an open, welcoming, diverse, inclusive, and healthy space for everyone.", - link: { text: "Learn more", href: "/community/coc" }, + link: { text: "Learn more", href: "https://www.apache.org/foundation/policies/conduct"; }, }, { title: "Brand Guidelines", @@ -214,10 +214,10 @@ let COMMUNITY_PAGE: CommunityPageConfig = { { title: "Security Policy", content: - "View the security policy to learn how to report security issues to us.", + "View the Apache security policy to learn how to report security issues to us.", link: { text: "Learn the security policy", - href: "/community/security", + href: "https://github.com/apache/cloudberry/blob/main/SECURITY.md";, }, }, ], @@ -383,7 +383,7 @@ if (isZhLangrage()) { "欢迎订阅 CloudberryDB Youtube 频道，第一时间查看我们发布的视频。", link: { text: "现在观看", - href: "https://youtube.com/@cloudberrydb";, + href: "https://youtube.com/@ApacheCloudberry";, }, }, ], diff --git a/src/consts/contribute.tsx b/src/consts/contribute.tsx index d0cb285c..8646caa8 100644 --- a/src/consts/contribute.tsx +++ b/src/consts/contribute.tsx @@ -22,7 +22,7 @@ let CONTRIBUTE_PAGE_CONFIG: ConfigProps = { headerCard: { titleText: "From user to contributor, no contribution is too small. We welcome contributions from anyone, new and experienced!", - subTitle: `Cloudberry Database is maintained actively by a group of database + subTitle: `Apache Cloudberry is maintained actively by a group of database experts by individuals and companies. We believe in the power of open source way and community. All contributions are encouraged, including code enhancements, bug fixes, feature proposals, @@ -33,7 +33,7 @@ let CONTRIBUTE_PAGE_CONFIG: ConfigProps = { { title: "Find a Way to Contribute", content: - "There are many ways you need to get started. The most common contributions include code, documentation, and community support. You can do a lot of things to make Cloudberry Database better. See the contribution guide to find a way to contribute, how you can ask for help, and what benefits you can get from your contribution.", + "There are many ways you need to get started. The most common contributions include code, documentation, and community support. You can do a lot of things to make Cloudberry better. See the contribution guide to find a way to contribute, how you can ask for help, and what benefits you can get from your contribution.", linkText: "Check the contribution guide", href: "/contribute/how-to-contribute", }, @@ -59,7 +59,7 @@ let CONTRIBUTE_PAGE_CONFIG: ConfigProps = { <Card className={styles.secondPosition} iconImgSrc="/img/home/feature/muc-light.svg" - content="For any major changes to the Cloudberry Database, please consider initiating one proposal." + content="For any major changes to the Cloudberry, please consider initiating one proposal." linkText="See the proposal process" href="/contribute/proposal" /> @@ -90,90 +90,9 @@ let CONTRIBUTE_PAGE_CONFIG: ConfigProps = { </span> ), }, - { - style: { marginBottom: 67, marginTop: 16 }, - title: - "“ As the next-generation unified database, Cloudberry Database cannot grow without the community. Hope to make our mission with you! ”", - }, ], }; -// zh language -if (isZhLangrage()) { - CONTRIBUTE_PAGE_CONFIG = { - headerCard: { - titleText: - "从用户到贡献者，贡献不分大小。无论新老，我们都欢迎你成为贡献者！", - subTitle: `Cloudberry Database 由一群具备行业顶尖水平的数据库专家团队负责维护。我们相信开源和社区的力量。我们鼓励所有的贡献，包括代码增强、Bug 修复、功能提案、文档、市场营销等。无论新手还是老鸟，我们都欢迎。`, - }, - textListItems: [ - { - title: "探索贡献方式", - content: - "贡献多种多样。最常见的贡献方式包括代码贡献、文档贡献和社区支持。你可以做很多事情让 Cloudberry Database 变得更好。欢迎参阅贡献指南，了解如何做出贡献、寻求帮助以及你可以从贡献中获得什么好处。", - linkText: "参阅贡献指南", - href: "/contribute/how-to-contribute", - }, - { - title: "学会使用 Git & GitHub", - content: - "不要急于开始！你需要学习如何更好地使用 GitHub 和 Git 进行协作，这对你的贡献很有帮助，并帮你和其他成员高效沟通。本文档列出了后续会用到的一些关键点。", - linkText: "准备关键技能", - href: "/contribute/git", - }, - { - style: { marginTop: 5, paddingBottom: 53 }, - title: "代码贡献", - children: ( - <div className={clsx(styles.codeContribution, "link-wrap")}> - <Card - className={styles.firstPosition} - iconImgSrc="/img/home/feature/mef.png" - content="了解代码规范、贡献流程、如何审阅代码，以及贡献者检查清单。" - linkText="开始代码贡献" - href="/contribute/code" - /> - <Card - iconImgSrc="/img/home/feature/cc.png" - content="对涉及 Cloudberry Database 的任何重大变更，请考虑发起一项提案。" - linkText="查看提案流程" - href="/contribute/proposal" - /> - </div> - ), - }, - { - title: "文档贡献", - content: - "我们欢迎你对网站和文档做贡献。", - linkText: "帮助改进文档", - href: "/contribute/doc", - }, - { - title: "获取帮助", - style: { marginTop: 10 }, - content: ( - <span> - "欢迎在 Slack{" "} - <span className={styles.highLight}>#dev</span> 频道或{" "} - <span className={styles.highLight}> - <LinkWithBaseUrl to="https://github.com/apache/cloudberry/discussions";> - GitHub Discussions - </LinkWithBaseUrl> - </span>{" "} - 上向我们咨询关于贡献方面的问题，特别是你在初次贡献遇到卡壳时。不要害羞，我们非常乐意帮大家解决贡献过程中的问题或疑惑。" - </span> - ), - }, - { - style: { marginBottom: 67, marginTop: 16 }, - title: - "“作为下一代统一型开源数据库，Cloudberry Database 没有社区就无法成长。希望与你一起实现目标！”", - }, - ], - }; -} - CONTRIBUTE_PAGE_CONFIG.textListItems.forEach((item) => { item.id = formatStrHorizontalLine(item.title); }); diff --git a/src/consts/homeContent.tsx b/src/consts/homeContent.tsx index 68ba9318..2c1ac71e 100644 --- a/src/consts/homeContent.tsx +++ b/src/consts/homeContent.tsx @@ -17,19 +17,19 @@ let MMP_ARCHITECTURE = { pic: "/img/home/os.png", title: "Petabyte-Scale Data", content: - "Cloudberry Database offers excellent performance for handling large-scale data workloads with high throughput.", + "Apache Cloudberry offers excellent performance for handling large-scale data workloads with high throughput.", }, { pic: "/img/home/pr.png", title: "Mature Technology", content: - "Cloudberry Database integrates solid PostgreSQL and Greenplum Database upstream technology, which both have wide adoption, active ecosystems, and tons of real-world use cases.", + "Apache Cloudberry integrates solid PostgreSQL and Greenplum Database upstream technology, which both have wide adoption, active ecosystems, and tons of real-world use cases.", }, { pic: "/img/home/pc.png", title: "Security Reinforcement", content: - "Cloudberry Database supports more encryption methods and algorithms including AES 128, AES 192, AES 256, DES and SCRAM-SHA-256, MD5, LDAP, and RADIUS.", + "Apache Cloudberry supports more encryption methods and algorithms including AES 128, AES 192, AES 256, DES and SCRAM-SHA-256, MD5, LDAP, and RADIUS.", }, ], }; @@ -39,7 +39,7 @@ let OUR_ROADMAP = { subTitle: ( <> <div> - Welcome to join us in shaping the future of Cloudberry Database, + Welcome to join us in shaping the future of Apache Cloudberry, </div> <a className="active-color" @@ -107,7 +107,7 @@ let TRY_IT_OUT = { <div> <div>1. Clone the latest source code.</div> <span className="code-block"> - git clone https://github.com/cloudberrydb/cloudberrydb.git + git clone https://github.com/apache/cloudberry.git </span> </div> <div> @@ -171,7 +171,7 @@ let SLACK_TWITTER_TWITTER_WECHAT = { { title: "Twitter", icon: "/img/home/links/twitter.svg", - desc: 'Follow @cloudberrydb on Twitter("X" now).', + desc: 'Follow @ASFCloudberry on Twitter("X" now).', link: "https://x.com/ASFCloudberry";, }, { @@ -286,16 +286,13 @@ let FREQUENTLY_ASKED_QUESTIONS = { ], }; -// zh language -if (isZhLangrage()) { -} const LINKS = { - github: "https://github.com/cloudberrydb";, + github: "https://github.com/apache/cloudberry";, twitter: "https://x.com/ASFCloudberry";, - youtube: "https://youtube.com/@cloudberrydb";, + youtube: "https://youtube.com/@ApacheCloudberry";, community: "https://inviter.co/apache-cloudberry";, - linkedIn: "https://www.linkedin.com/company/cloudberrydb";, + linkedIn: "https://www.linkedin.com/company/apache-cloudberry";, wechat: "/community/wechat", discoverMore: "/docs", }; diff --git a/src/consts/support.tsx b/src/consts/support.tsx index 37318ed8..a31f7830 100644 --- a/src/consts/support.tsx +++ b/src/consts/support.tsx @@ -2,9 +2,9 @@ import LinkWithBaseUrl from "../components/common/LinkWithBaseUrl"; import { isZhLangrage } from "../utils"; const configData = { - titleText: "Cloudberry Database Support", + titleText: "Support for Apache Cloudberry", subText: - "Welcome to our support page! Our team is ready to help you make the most of the Cloudberry Database. Explore the resources and let us assist you in harnessing its full potential.", + "Welcome to our support page! Our team is ready to help you make the most of the Apache Cloudberry. Explore the resources and let us assist you in harnessing its full potential.", contentTextDesc: "This page shows that how you can ask for help and get support from our community.", tableData: [ @@ -14,7 +14,7 @@ const configData = { Download </LinkWithBaseUrl> ), - desc: "You can download the Cloudberry Database releases and see the changelogs.", + desc: "You can download the Apache Cloudberry releases and see the changelogs.", }, { type: ( @@ -24,7 +24,7 @@ const configData = { ), desc: ( <> - Official documentation for Cloudberry Database. You can explore it to + Official documentation for Apache Cloudberry. You can explore it to discover more details about us. If you want to contribute, see{" "} <LinkWithBaseUrl href="/contribute/doc" className="active-color"> the guide @@ -37,10 +37,10 @@ const configData = { type: "Report bugs", desc: ( <> - Problems and issues in Cloudberry Database core. If you find bugs, + Problems and issues in Apache Cloudberry core. If you find bugs, welcome to submit them{" "} <LinkWithBaseUrl - href="https://github.com/cloudberrydb/cloudberrydb/issues"; + href="https://github.com/apache/cloudberry/issues"; className="active-color" target="_blank" > @@ -56,7 +56,7 @@ const configData = { <> View our{" "} <LinkWithBaseUrl - href="https://github.com/cloudberrydb/cloudberrydb/security/policy"; + href="https://github.com/apache/cloudberry/blob/main/SECURITY.md"; className="active-color" target="_blank" > @@ -70,7 +70,7 @@ const configData = { type: "Q&A", desc: ( <> - Ask for help when running/developing Cloudberry Database, visit GitHub{" "} + Ask for help when running/developing Apache Cloudberry, visit GitHub{" "} <LinkWithBaseUrl href="https://github.com/apache/cloudberry/discussions/categories/q-a"; className="active-color" @@ -102,7 +102,7 @@ const configData = { type: "Code contribution", desc: ( <> - Fix bugs, add new features to Cloudberry Database, visit our guide on{" "} + Fix bugs, add new features to Apache Cloudberry, visit our guide on{" "} <LinkWithBaseUrl href="/contribute/how-to-contribute" className="active-color" @@ -164,13 +164,13 @@ const configData = { </LinkWithBaseUrl> ,{" "} <LinkWithBaseUrl - href="https://youtube.com/@cloudberrydb"; + href="https://youtube.com/@ApacheCloudberry"; className="active-color" target="_blank" > Youtube </LinkWithBaseUrl>{" "} - to help spread good words on Cloudberry Database. Welcome to{" "} + to help spread good words on Apache Cloudberry. Welcome to{" "} <LinkWithBaseUrl href="/community/slack" className="active-color" @@ -196,225 +196,9 @@ const configData = { commercialDesc: ( <> Commercial support is available from many companies that provide - professional services to the Cloudberry Database community. You can{" "} - <LinkWithBaseUrl - className={"active-color"} - href="https://hashdata.feishu.cn/share/base/form/shrcnJIVr3gTDXPvKkWMtBkXv5e?open_in_browser=true"; - > - submit your support request - </LinkWithBaseUrl>{" "} - to us. - <div style={{ fontSize: "smaller" }}> - We will help coordinate with the relevant vendors to assist you in - resolving your troubles. By submitting the request form, you acknowledge - that we will share your information with the appropriate vendors. - </div> + professional services to the Apache Cloudberry community. We will add more vendors' information here. </> ), }; -if (isZhLangrage()) { - configData.titleText = "Cloudberry Database 支持"; - configData.subText = - "欢迎来到支持页面！我们随时待命，帮你用好 Cloudberry Database。探索可用资源，发挥 Cloudberry Database 全部潜力。"; - configData.contentTextDesc = "本页展示了如何寻求帮助和支持。"; - configData.tableData = [ - { - type: ( - <LinkWithBaseUrl href="/docs/releases/" className="active-color"> - 软件下载 - </LinkWithBaseUrl> - ), - desc: "你可以下载 Cloudberry Database 对应版本并查看更新日志。", - }, - { - type: ( - <LinkWithBaseUrl href="/docs" className="active-color"> - 用户文档 - </LinkWithBaseUrl> - ), - desc: ( - <> - Cloudberry Database 的官方文档。你可以浏览文档，了解更多详细信息。如果你想为文档做出贡献，请参阅{""} - <LinkWithBaseUrl href="/contribute/doc" className="active-color"> - 《文档贡献指南》 - </LinkWithBaseUrl> - 。 - </> - ), - }, - { - type: "报告错误", - desc: ( - <> - 反馈 Cloudberry Database 核心中的问题。如果你发现了 Bug，欢迎提交到 - {" "} - <LinkWithBaseUrl - href="https://github.com/cloudberrydb/cloudberrydb/issues"; - className="active-color" - target="_blank" - > - GitHub Issue - </LinkWithBaseUrl> - 。 - </> - ), - }, - { - type: "报告安全漏洞", - desc: ( - <> - 查看{""} - <LinkWithBaseUrl - href="https://github.com/cloudberrydb/cloudberrydb/security/policy"; - className="active-color" - target="_blank" - > - 《安全策略》 - </LinkWithBaseUrl>{""} - 了解如何报告安全问题，以及如何与我们联络。 - </> - ), - }, - { - type: "Q&A / 问答", - desc: ( - <> - 在运行/开发 Cloudberry Database 时遇到问题，可在 {" "} - <LinkWithBaseUrl - href="https://github.com/apache/cloudberry/discussions/categories/q-a"; - className="active-color" - target="_blank" - > - GitHub Discussions - QA - </LinkWithBaseUrl>{" "} - 模块发帖求助。 - </> - ), - }, - { - type: "新点子 / 功能需求", - desc: ( - <> - 分享有关新功能的想法，请前往{" "} - <LinkWithBaseUrl - href="https://github.com/apache/cloudberry/discussions/categories/ideas-feature-requests"; - className="active-color" - target="_blank" - > - GitHub Discussions - Ideas - </LinkWithBaseUrl>{" "} - 模块发帖。 - </> - ), - }, - { - type: "代码贡献", - desc: ( - <> - 贡献方式多种多样，如修复错误、为 Cloudberry Database 开发新功能，详情可参考文档 - <LinkWithBaseUrl - href="/contribute/how-to-contribute" - className="active-color" - > - 《如何做出贡献》 - </LinkWithBaseUrl> - 、 - <LinkWithBaseUrl href="/contribute/git" className="active-color"> - 《使用 Git & GitHub》 - </LinkWithBaseUrl> - 、 - <LinkWithBaseUrl href="/contribute/code" className="active-color"> - 《代码贡献指南》 - </LinkWithBaseUrl> - 以及 - <LinkWithBaseUrl href="/contribute/proposal" className="active-color"> - 《Cloudberry Database 提案指南》 - </LinkWithBaseUrl> - 等。 - </> - ), - }, - { - type: "社区活动", - desc: ( - <> - 包括 Meetup、网络研讨会 Webinar、会议和更多活动信息，可查看页面 - <LinkWithBaseUrl href="/community/events" className="active-color"> - 社区活动 - </LinkWithBaseUrl> - 了解详情，并订阅活动日历。 - </> - ), - }, - { - type: "品牌指南", - desc: ( - <> - 关于如何下载和使用项目 Logo、名称和字体等事宜，可查看文档 - <LinkWithBaseUrl href="/community/brand" className="active-color"> - 《品牌指南》 - </LinkWithBaseUrl> - 了解详情。 - </> - ), - }, - { - type: "社交渠道", - desc: ( - <> - 欢迎关注{" "} - <LinkWithBaseUrl - href="https://x.com/ASFCloudberry"; - className="active-color" - target="_blank" - > - Twitter - </LinkWithBaseUrl> - 、 - <LinkWithBaseUrl - href="https://youtube.com/@cloudberrydb"; - className="active-color" - target="_blank" - > - Youtube - </LinkWithBaseUrl>{" "} - 与我们互动，并转发 Cloudberry Database 相关话题和推文。同时，欢迎加入{" "} - <LinkWithBaseUrl - href="/community/slack" - className="active-color" - target="_blank" - > - Slack - </LinkWithBaseUrl>{" "} - 或{" "} - <LinkWithBaseUrl - href="/community/wechat" - className="active-color" - target="_blank" - > - 微信 - </LinkWithBaseUrl>{" "} - 对应频道或群组，与社区成员聊天。 - </> - ), - }, - ]; - configData.communitySupportText = "社区支持"; - configData.commercialSupportText = "商业服务"; - configData.commercialDesc = ( - <> - 目前有众多公司为 Cloudberry Database 社区提供商业服务支持。你可以 - <LinkWithBaseUrl - className={"active-color"} - href="https://hashdata.feishu.cn/share/base/form/shrcnJIVr3gTDXPvKkWMtBkXv5e?open_in_browser=true"; - > - 点此提交支持需求表单。 - </LinkWithBaseUrl> - <div style={{ fontSize: "smaller" }}> - 我们将协调相关商业服务商，以帮助为你提供最优支持方案。提交支持需求表单，意味着你已同意我们将与合适的供应商共享你的需求信息。 - </div> - </> - ); -} export default configData; diff --git a/src/pages/community/coc.md b/src/pages/community/coc.md deleted file mode 100644 index 5615b673..00000000 --- a/src/pages/community/coc.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Contributor Covenant Code of Conduct -description: Let's work together to create a space that is open, welcoming, diverse, inclusive, and healthy for everyone. ---- - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual -identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall - community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or advances of - any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, - without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at [email protected]. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.1, available at -[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. - -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. - -For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at -[https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations diff --git a/src/pages/community/events.md b/src/pages/community/events.md index 14c7ffde..437a413a 100644 --- a/src/pages/community/events.md +++ b/src/pages/community/events.md @@ -11,7 +11,7 @@ summits, conferences, Office Hours, and more! :::note If you want to add your events related to the Apache Cloudberry, -welcome to email us: [email protected]. +welcome to email us: [email protected]. ::: diff --git a/src/pages/community/security.md b/src/pages/community/security.md deleted file mode 100644 index 91e9ad3b..00000000 --- a/src/pages/community/security.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Security Policy -description: Learn how to report security issues to us. ---- - -## Reporting Security Issues - -To report a security issue, please email -[[email protected]](mailto:[email protected]). This -project follows a 90-day disclosure timeline. We will publish the -[security -advisories](https://github.com/cloudberrydb/cloudberrydb/security/advisories) -via GitHub. - -You should receive a response within 2 weeks. If for some reason you -do not, please follow up via email to ensure we received your original -message. - -Please include the requested information listed below (as much as you -can provide) to help us better understand the nature and scope of the -possible issue: - -* Type of issue (e.g. buffer overflow, SQL injection, cross-site - scripting, etc.) -* Full paths of source file(s) related to the manifestation of the - issue -* The location of the affected source code (tag/branch/commit or - direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the - issue - -This information will help us triage your report more quickly. - -## Do not - -For better collaboration, we hope you: - -- Do not file public issues on GitHub for security vulnerabilities. -- Do not report non-security-impacting bugs through this channel. If - you have any questions on using, development, please use [GitHub - Issues, Discussions or - Slack](https://github.com/cloudberrydb/cloudberrydb/issues/new/choose) - instead. - -## Handling Process - -Here's an overview of the security issues handling process: - -* The reporter reports the security issues to the Cloudberry Database - team. -* The Cloudberry Database team investigates the report and decides to - accept or reject the report. If our team rejects the report, the - team will explain why to the reporter. If we accept the report, our - team will work privately with the reporter to fix the security - issues. -* Release the new version of the Cloudberry Database that includes the - fix. -* Public the security issues. - -## Preferred Languages - -We prefer all communications to be in English. - ---- - -Thanks for helping make Cloudberry Database safe! diff --git a/src/pages/community/slack.md b/src/pages/community/slack.md index 54521f89..62d4a7a6 100644 --- a/src/pages/community/slack.md +++ b/src/pages/community/slack.md @@ -3,13 +3,12 @@ title: Slack Guide description: The channel for global community members to chat with each other in real-time. Get started by reading our guide on Slack. --- -Thanks so much for your interest in joining Cloudberry Database's +Thanks so much for your interest in joining Apache Cloudberry's Slack channels! We have different platforms for our community members to communicate, including [GitHub -Issues](https://github.com/cloudberrydb/cloudberrydb/issues), and -[GitHub +Issues](https://github.com/apache/cloudberry/issues), and [GitHub Discussions](https://github.com/apache/cloudberry/discussions). They're all asynchronous communication channels, but if you want real-time chatting with other people, you can join Slack. @@ -23,14 +22,13 @@ the following channels: |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| | `#general` | This channel is for workspace-wide communication and announcements. All members are in this channel. | | `#announcements` | Announcements regarding new releases, blogs, webinars, meetups and other events. | -| `#dev` | Pull requests, bug discussions, new Features, and other dev works. | +| `#dev` | Pull requests, bug discussions, new Features, and other dev works. | | `#introductions` | New to Slack? Please do say hello! Let us know who you are, and what your interests are, so we can help you to kick-start as smoothly as possible! | -| `#events` | A place to share events relevant to the Cloudberry Database community, including webinars, meetups, conferences, summits, etc. | +| `#events` | A place to share events relevant to the Apache Cloudberry community, including webinars, meetups, conferences, summits, etc. | | `#docs` | The Channel for documents and website updates. | | `#cicd` | CICD pipeline, build, release topics. | -| `#github` | Status on Cloudberry Database's pull requests, and issues. | | `#random` | A channel to post and discuss random topics related to the database. | -| `#jobs` | This is the place for recruitment and sharing opportunities related to Cloudberry Database, PostgreSQL and other databases. | +| `#jobs` | This is the place for recruitment and sharing opportunities related to Apache Cloudberry, PostgreSQL and other databases. | After joining, we encourage you to share a bit about yourself and what brings you here at the `#introductions` channel, so the community @@ -39,8 +37,9 @@ members can get to know you better. ## Ground rules **Be kind!** We lead by our community [Code of -Conduct](https://cloudberrydb.org/community/coc), please be kind and -keep open. We want to make a friendly space for all members. +Conduct](https://www.apache.org/foundation/policies/conduct), please +be kind and keep open. We want to make a friendly space for all +members. **Avoid global notifications.** If you're not the admin or owner, please avoid using global notifications such as @here/@channel etc in @@ -52,4 +51,4 @@ a warning, repeated offense may lead to removal. ## Join -Click to join our Slack channel! [](https://inviter.co/apache-cloudberry) +Click to join our Slack channel! [](https://inviter.co/apache-cloudberry) diff --git a/src/pages/community/wechat.md b/src/pages/community/wechat.md index f372cb8f..4e1a23c3 100644 --- a/src/pages/community/wechat.md +++ b/src/pages/community/wechat.md @@ -12,15 +12,16 @@ friend by scanning the QR code below and asking to join. Once you have joined, we encourage you to introduce yourself and share what you want to learn, so the community members can get to know you better. If you -have any questions about CloudberryDB, feel free to ask in the WeChat groups. +have any questions about Cloudberry, feel free to ask in the WeChat groups. However, we kindly request that you search for your questions beforehand to avoid repetition. ## Group rules **Be kind!** We lead by our community [Code of -Conduct](https://cloudberrydb.org/community/coc), please be kind and keep -open. We want to make a friendly space for all members. +Conduct](https://www.apache.org/foundation/policies/conduct), please +be kind and keep open. We want to make a friendly space for all +members. **Be patient!** We adopt the asynchronous communication way. Please be patient to wait for other community members's replies to your questions. If no one diff --git a/src/pages/contribute/code.md b/src/pages/contribute/code.md index 2159fc07..687bf4c3 100644 --- a/src/pages/contribute/code.md +++ b/src/pages/contribute/code.md @@ -5,9 +5,9 @@ description: Learn the code conventions, contribution workflow, how to review co ## Code of Conduct -Everyone who participates in Apache Cloudberry, either as a user or -a contributor, is obliged to follow our [community Code of -Conduct](../community/coc). +Everyone who participates in Apache Cloudberry, either as a user or a +contributor, is obliged to follow our [community Code of +Conduct](https://www.apache.org/foundation/policies/conduct). ## Ready to contribute @@ -25,30 +25,12 @@ the GitHub Issues with labels “good first issue” and "help wanted" which can help you familiarize yourself with the contribution workflow, and for the dev teams to become acquainted with you. -In addition, all code contributors are required to sign a Contributor -License Agreement (CLA), you can sign it as CLA assistant prompts when -submitting your first Pull Request. - -:::caution - -It's not required for upstream contributors to sign CLA if you cherry -pick the commits from upstream projects like PostgreSQL or Greenplum -Database, so just ignore the CLA assistant's warning, which will not -block your PR's merge. - -::: - :::warning -In addition, please don't change(remove) the original copyright -information and open source license headers. If you have modified the -files at large, you can add information following the original file -license. - Don't import components under GPLv2/3 License or other non-OSI -licenses for your code, which will interfere with Cloudberry -Database's Apache License. If you are not sure, please contact [email protected]. +licenses for your code, which will interfere with Cloudberry's Apache +License. If you are not sure, please contact [email protected]. ::: @@ -71,13 +53,13 @@ in the PostgreSQL codebase we can `try to make your patch consistent with nearby code`(See discussions in [PostgreSQL mailing list](https://www.postgresql.org/message-id/16342.1221133325%40sss.pgh.pa.us).) -We can use existing configurations for Apache Cloudberry -development, such as -[Vim](https://github.com/cloudberrydb/cloudberrydb/blob/main/src/tools/editors/vim.samples), -[Emacs](https://github.com/cloudberrydb/cloudberrydb/blob/main/src/tools/editors/emacs.samples), -[Clion](https://github.com/cloudberrydb/cloudberrydb/blob/main/src/tools/editors/clion.xml) +We can use existing configurations for Apache Cloudberry development, +such as +[Vim](https://github.com/apache/cloudberry/blob/main/src/tools/editors/vim.samples), +[Emacs](https://github.com/apache/cloudberry/blob/main/src/tools/editors/emacs.samples), +[Clion](https://github.com/apache/cloudberry/blob/main/src/tools/editors/clion.xml) and [other -editors](https://github.com/cloudberrydb/cloudberrydb/blob/main/.editorconfig). +editors](https://github.com/apache/cloudberry/blob/main/.editorconfig). ### Error Messages @@ -94,26 +76,26 @@ guide](./git) again. To contribute to Apache Cloudberry development: 1. Fork the [Apache Cloudberry -repo](https://github.com/cloudberrydb/cloudberrydb) to your own GitHub +repo](https://github.com/apache/cloudberry) to your own GitHub account. 2. Clone down the repo to your local system. ``` - $ git clone [email protected]:your-user-name/cloudberrydb.git + $ git clone https://github.com/your-user-name/cloudberry.git ``` 3. Add the upstream repo. (You only have to do this once, not every time.) ``` - $ git remote add upstream https://github.com/cloudberrydb/cloudberrydb.git + $ git remote add upstream https://github.com/apache/cloudberry.git ``` now, when you run `git remote -v` will show two remote repositories named: - * `upstream`, which refers to the 'cloudberrydb' repository + * `upstream`, which refers to the 'apache/cloudberry' repository * `origin`, which refers to your personal fork 4. Create a new branch to hold your work. @@ -153,10 +135,11 @@ refer to [Commit Conventions](./git#commit-conventions). 9. Get your code reviewed. Apache Cloudberry maintainers and other contributors will review - your PR. Please participate in the conversation, and try to make any - requested changes. If you get no review comments within two weeks, - feel free to ask for feedback by mentioning @cloudberry/dev team in - your PR comment. + your PR. Please participate in the conversation, and try to make + any requested changes. If you get no review comments within two + weeks, feel free to ask for feedback by ask the [cloudberry + committers](https://github.com/orgs/apache/teams/cloudberry-committers) + in your PR comment. Once the maintainers are happy with your change, they'll approve the pull request. At this point, the maintainer will take over, possibly @@ -184,8 +167,13 @@ repository is up to date: ``` $ git fetch upstream ``` +3. Rebase your codebase to the upstream main branch. + + ``` + $ git rebase upstream/main + ``` -3. Create a new branch if you are starting new work. +4. Create a new branch if you are starting new work. ``` $ git checkout -b branch-name @@ -222,13 +210,13 @@ Here are some questions to keep in mind during the code review process: - Do we want this in Apache Cloudberry? Is it likely to be used? Do - you, as a Apache Cloudberry user, like the change and intend to - use it? Is this change in the scope of Apache Cloudberry? Will the - cost of maintaining a new feature be worth its benefits? + you, as a Apache Cloudberry user, like the change and intend to use + it? Is this change in the scope of Apache Cloudberry? Will the cost + of maintaining a new feature be worth its benefits? - Is it too large to review? Does it need to split into multi PR? - If it's a proposal, does it have been accepted and start to code? -- Is it duplicated with other existing code contributions in CBDB or - commits in upstream projects? +- Is it duplicated with other existing code contributions in + Cloudberry or commits in upstream projects? - Does it follow our code conventions? - Does it need to have a proposal before getting the code review? - Does the PR have a good commit message following our commit @@ -258,13 +246,11 @@ For acronyms and abbreviations used in the code review, you can read * Read the contributing guidelines. * Read the Code of Conduct. -* Ensure you have signed the Contributor License Agreement (CLA), - especially for your first-time contribution. * Check if your changes are consistent with the Apache Cloudberry coding style. * Make sure your Pull Request has a clear title and commit message. * List your communication in the [GitHub - Issues](https://github.com/cloudberrydb/cloudberrydb/issues) or + Issues](https://github.com/apache/cloudberry/issues) or [Discussions](https://github.com/apache/cloudberry/discussions) (if has or needed). * Run the unit tests and regression tests. diff --git a/src/pages/contribute/doc.md b/src/pages/contribute/doc.md index 57f4f12b..9a40fe65 100644 --- a/src/pages/contribute/doc.md +++ b/src/pages/contribute/doc.md @@ -1,5 +1,5 @@ --- -title: Documentation Contribution Guide +title: Documentation Contribution Guide description: We appreciate any contributions you can make to our documentation, including the website and other related materials. --- @@ -7,7 +7,7 @@ description: We appreciate any contributions you can make to our documentation, We are committed to fostering a welcoming and respectful community. All contributors are expected to adhere to our [Code of -Conduct](https://cloudberrydb.io/community/coc). +Conduct](https://www.apache.org/foundation/policies/conduct). ## What contributors can do @@ -28,6 +28,8 @@ Here are some of the key files in our documentation repository: - `i18n/zh/docusaurus-plugin-content-docs/current/`: This directory contains the Chinese documentation. +If you want to add other language support for the documents, welcome! + ## How to contribute :::info @@ -42,9 +44,8 @@ create a Pull Request. For simple updates such as typo or link fixing in a single document: -1. Navigate to the target page on the [Apache Cloudberry - documentation site](https://cloudberrydb.io/docs/) you - wish to update. +1. Navigate to the target page on the [Apache Cloudberry documentation + site](https://cloudberry.apache.org/docs/) you wish to update. 2. Click **Edit this page** at the left bottom of the page. This will take you to the GitHub edit page for that file. 3. Make your changes in the GitHub editor. @@ -52,14 +53,13 @@ For simple updates such as typo or link fixing in a single document: description of your changes in the first field, and a more detailed description in the second field. 5. Click **Propose changes** to create a pull request. -6. Sign the Contributor License Agreement as CLAassistant prompts. ### For more complex updates or new content For more complex updates or adding new content in multiple documents: 1. Fork the [Apache Cloudberry site - repository](https://github.com/cloudberrydb/cloudberrydb-site). + repository](https://github.com/apache/cloudberry-site). 2. Clone your forked repository to your local machine. 3. Create a new branch for your changes. 4. Make your changes in your local environment. @@ -67,12 +67,11 @@ For more complex updates or adding new content in multiple documents: 6. Navigate to the original Apache Cloudberry site repository. 7. Click **New pull request**. 8. Choose your forked repository's branch in the comparison, and - choose the `main` branch for the `cloudberrydb/cloudberrydb-site` + choose the `main` branch for the `apache/cloudberry-site` repository. 9. Enter a clear and concise title for your pull request. In the description, explain the purpose of your changes. 10. Click **Create pull request**. -11. Sign the Contributor License Agreement as CLAassistant prompts. ## Styling @@ -102,9 +101,9 @@ For more details about writing styles, you can read: ## PR Review Process After you submit your PR, it will be reviewed by the Cloudberry -Database team. We aim to review PRs within a week of submission, but -it might take longer depending on the complexity of the changes. We -appreciate your patience during this process. +team. We aim to review PRs within a week of submission, but it might +take longer depending on the complexity of the changes. We appreciate +your patience during this process. Please keep an eye on your PR after submission. You might receive feedback or questions in the PR comments. Addressing these comments @@ -117,10 +116,10 @@ adding a new section or rewriting a large part of it, we recommend the following process: 1. Open an issue in the [Apache Cloudberry site - repository](https://github.com/cloudberrydb/cloudberrydb-site) - describing your proposed changes. This allows the Cloudberry - Database team and community to provide feedback before you invest a - lot of time in writing. + repository](https://github.com/apache/cloudberry-site) describing + your proposed changes. This allows the Cloudberry team and + community to provide feedback before you invest a lot of time in + writing. 2. Once you have received feedback and agreement on your proposal, follow the contribution process described above to implement your changes and submit a pull request. diff --git a/src/pages/contribute/git.md b/src/pages/contribute/git.md index edba0e8c..778ead66 100644 --- a/src/pages/contribute/git.md +++ b/src/pages/contribute/git.md @@ -3,11 +3,10 @@ title: Working with Git & GitHub description: Before starting, it's important to learn Git and GitHub to effectively contribute and communicate with other members. --- -Apache Cloudberry (Incubating) is hosted on GitHub. We use GitHub Issues as the -bug report system, use GitHub Discussions for discussion and get -feedback, and use Git as our version control system. Given these, it's -important for community users and developers to learn how to work well -with GitHub and Git. +Apache Cloudberry (Incubating) is hosted on GitHub. We use GitHub +Issues as the bug report system, and use Git as our version control +system. Given these, it's important for community users and developers +to learn how to work well with GitHub and Git. Please note, we do not aim to write one complete guide for Git or GitHub on this page, but we list the key points in your future work. @@ -22,11 +21,7 @@ please create one. Then you need to edit your public GitHub profile, including your name, avatar, bio, social accounts, etc. to let other people know you. -### Step 2: Configure two-factor authentication - -This is required only for Apache Cloudberry organization members, -including committers, and PMC members. If you're an outside -contributor, you can skip this step. +### (Option) Step 2: Configure two-factor authentication You can take [GitHub Document: Configuring two-factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) @@ -54,8 +49,7 @@ git config --global user.name "Your Name" :::caution If you are used to working on different laptops, please make sure to -have the same email address and name settings for your Git, in case -that our CLABot has difficulty detecting the contributor information. +have the right email address and name settings. ::: @@ -83,7 +77,7 @@ pull request. ## Commit Conventions We have one [git commit message -template](https://raw.githubusercontent.com/cloudberrydb/cloudberrydb/main/.gitmessage) +template](https://raw.githubusercontent.com/apache/cloudberry/main/.gitmessage) for coding contributions. You can download the file and run the following command to apply it globally: @@ -212,7 +206,7 @@ new features, and share proposals for Apache Cloudberry. If you find problems and issues with code in Apache Cloudberry core, welcome to report to [GitHub -Issues](https://github.com/cloudberrydb/cloudberrydb/issues/new/choose). +Issues](https://github.com/apache/cloudberry/issues/new/choose). If you want to ask for help, answer questions, share your new ideas for features, and get feedback for your proposal, please [create new @@ -223,7 +217,7 @@ directly. |------------------------------|------------------------------------------------------------------| | Announcements | New Release, events, blog and more (*Only maintainers can post*) | | Ideas / Feature Requests | Share ideas for new features | -| Proposal | Share proposals of major changes to Apache Cloudberry | +| Proposal | Share proposals of major changes to Apache Cloudberry | | Q&A | Ask the community for help | :::note @@ -232,54 +226,6 @@ guide](https://resources.github.com/devops/process/planning/discussions/)' to learn more. ::: -## GitHub Projects - -Now, our project is only public to the Apache Cloudberry -organization members. If you're a member, you can open -https://github.com/orgs/cloudberrydb/projects/5. We list the fields -for your reference. - -<table> -<thead> -<tr> -<th>Status</th> -<th>Priority</th> -<th>Size</th> -<th>Story Type</th> -</tr> -</thead> -<tbody> -<tr> -<td> -<p>🧊 Icebox</p> -<p>📋 Backlog</p> -<p>🏗 In progress</p> -<p>👀 In review</p> -<p>✅ Done</p> -</td> -<td> -<p>🌋 Urgent</p> -<p>🏔 High</p> -<p>🏕 Medium</p> -<p>🏝 Low</p> -</td> -<td> -<p>🐋 X-Large</p> -<p>🦑 Large</p> -<p>🐂 Medium</p> -<p>🐇 Small</p> -<p>🦔 Tiny</p> -</td> -<td> -<p>🤩 Feature</p> -<p>🥳 Chore</p> -<p>🐛 Bug</p> -<p>🚀️ Release</p> -</td> -</tr> -</tbody> -</table> - ## Advanced Usage in GitHub In addition to the plain text and [basic writing and formatting diff --git a/src/pages/contribute/how-to-contribute.md b/src/pages/contribute/how-to-contribute.md index 58f63d8d..4ba75150 100644 --- a/src/pages/contribute/how-to-contribute.md +++ b/src/pages/contribute/how-to-contribute.md @@ -9,13 +9,13 @@ guide will help you get started with the contribution. ## Code of Conduct -Everyone who participates in Apache Cloudberry, either as a user or -a contributor, is obliged to follow our community [Code of -Conduct](../community/coc). Every violation against it will be -reviewed and investigated and will result in a response that is deemed -necessary and appropriate to the circumstances. The moderator team is -obligated to maintain confidentiality regarding the reporter of an -incident. +Everyone who participates in Apache Cloudberry, either as a user or a +contributor, is obliged to follow our community [Code of +Conduct](https://www.apache.org/foundation/policies/conduct). Every +violation against it will be reviewed and investigated and will result +in a response that is deemed necessary and appropriate to the +circumstances. The moderator team is obligated to maintain +confidentiality regarding the reporter of an incident. Some behaviors that contribute to creating a positive environment include: @@ -41,13 +41,13 @@ You can participate by: - Answering questions on [GitHub Discussions](https://github.com/apache/cloudberry/discussions/categories/q-a). - Investigating [GitHub - issues](https://github.com/cloudberrydb/cloudberrydb/issues). + issues](https://github.com/apache/cloudberry/issues). - [Reporting a new - bug](https://github.com/cloudberrydb/cloudberrydb/issues/new/choose). + bug](https://github.com/apache/cloudberry/issues/new/choose). - [Sharing ideas for new features](https://github.com/apache/cloudberry/discussions/new?category=ideas-feature-requests). - Helping review [Pull - Requests](https://github.com/cloudberrydb/cloudberrydb/pulls) or + Requests](https://github.com/apache/cloudberry/pulls) or [Proposals](https://github.com/apache/cloudberry/discussions/categories/proposal). - Proposing your proposal, see [Proposal Guide](./proposal). - [Reporting security issues](../community/security). @@ -62,8 +62,8 @@ You can participate by: Feel free to reach out to us in [Slack `#dev` channels](../community/slack) or [GitHub -Discussions](https://github.com/cloudberrydb/cloudberrydb/discussions) -when your contribution is blocked, especially when making your first +Discussions](https://github.com/apache/cloudberry/discussions) when +your contribution is blocked, especially when making your first contribution. Don't be shy, we're happy to help. As the next-generation unified database, Apache Cloudberry cannot diff --git a/src/pages/contribute/proposal.md b/src/pages/contribute/proposal.md index 48c8048e..49e1ba9c 100644 --- a/src/pages/contribute/proposal.md +++ b/src/pages/contribute/proposal.md @@ -1,14 +1,20 @@ --- -title: Cloudberry Database Proposal Guide -description: If you are planning to make significant changes to the Cloudberry Database, please submit a proposal for review. +title: Apache Cloudberry Proposal Guide +description: If you are planning to make significant changes to the Apache Cloudberry, please submit a proposal for review. --- -This page describes a `Cloudberry Database Proposal(CP)` process for -proposing major changes to Cloudberry Database. +:::caution + +This page will be reshaped to match the Apache rules. + +::: + +This page describes a `Apache Cloudberry Proposal` process for +proposing major changes to Apache Cloudberry. ## When -Not all changes need one CP. +Not all changes need one proposal. When changes are just minor updates or general bug fixes, just create a pull request directly! @@ -21,10 +27,9 @@ to get feedback via GitHub Discussions. But any of the following can be considered a major change that needs to have a **Proposal**: -- Any change that impacts the public interfaces of Cloudberry - Database. +- Any change that impacts the public interfaces of Apache Cloudberry. - Any new component, module, or code that introduces a new concept - into Cloudberry Database or alters the behavior of an existing one. + into Apache Cloudberry or alters the behavior of an existing one. - Any large code refactors to address general code re-usability and structure. - Any important breaking backward or forward compatibility. @@ -39,7 +44,7 @@ directly in our Slack. ## Who -Anyone can initiate one CP. For the proposer, it can be only you, a +Anyone can initiate one proposal. For the proposer, it can be only you, a group of developers, or one team. Please list all the proposers' names in the proposal. @@ -56,7 +61,7 @@ Draft --> Discuss --> Vote -| Inactive ### Draft You can submit your proposal via [GitHub Discussions -template](https://github.com/apache/cloudberry/discussions/new?category=proposal). Fill +template](https://github.com/apache/cloudberry/discussions/new?category=proposal) or send it the `[email protected]`. Fill all the fields as you can, at least the required ones, including: - Proposal title. Be direct, and clear. Please also keep the prefix @@ -65,7 +70,7 @@ all the fields as you can, at least the required ones, including: team, company. - Proposal Status. Choose one from the following: `Under Discussion`/`In Progress`/`Completed`/`Inactive`/`Abandoned`, `Under -Discussion` as default when you initiate the CP. +Discussion` as default when you initiate the proposal. - Abstract. A clear and concise description of what your proposal is. - Motivation. Please outline the motivation and why it should be implemented. @@ -75,13 +80,13 @@ Discussion` as default when you initiate the CP. ### Discuss When your proposal draft is ready, you can share the GitHub link to -our `#dev` Slack Channel or mention others to get feedback from the +our `[email protected]` mainling list to get feedback from the community. It is important to be responsive to any questions or concerns raised by others. This stage is intended to gather a variety of feedback, suggestions, and constructive criticism from different perspectives. -The duration of your CP is at least 7 days, allowing community members +The duration of your proposal is at least 3 days, allowing community members from various timezones to view and participate in discussions until all concerns have been addressed. @@ -141,7 +146,7 @@ has been accepted you can do so following the same procedure. ::: Next up is breaking down tasks. You should break down tasks on -Cloudberry Database GitHub issues page. Once a proposal is accepted, +Apache Cloudberry GitHub issues page. Once a proposal is accepted, it moves into the implementation phase, status as `In Progress`. ### In Progress @@ -199,14 +204,3 @@ changes in your implementation. ::: ---- - -## List of Cloudberry Database Proposals(CPs) - -| No. | Title | Status | Discussion Thread | -| ---- | ---------------------------------------------------------------------------- | ------- | ---------------------------------------------------- | -| CP-2 | [Proposal] Implement Scorll Parallel Retrieve Cursor | Discuss | https://github.com/apache/cloudberry/discussions/120 | -| CP-1 | [Proposal] Support Incremental View Maintenance (IVM) in Cloudberry Database | Discuss | https://github.com/apache/cloudberry/discussions/36 | - -You can find more proposal -[here](https://github.com/cloudberrydb/community). diff --git a/src/theme/Footer/index.tsx b/src/theme/Footer/index.tsx index 5a3db032..213fa266 100644 --- a/src/theme/Footer/index.tsx +++ b/src/theme/Footer/index.tsx @@ -80,12 +80,6 @@ export default function Footer() { src={useBaseUrl((footerConfig as any).logo.src)} alt="" /> - <img - className={styles.swap} - onClick={handleCheckLang} - src={useBaseUrl("/img/en_zh.png")} - alt="" - /> </div> <div className={styles.links}> <GithubSvg --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
