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 0233fc5c03c96df34b9c5e9540a79ca4b6d9de3c Author: Dianjin Wang <[email protected]> AuthorDate: Thu Nov 28 15:57:44 2024 +0800 Doc: update the links and project name in GitHub files These changes are in the following files: * .asf.yaml * .github/pull_request_template.md * .github/workflows/publish-cloudberry-site.yml * .gitmessage * README.md --- .asf.yaml | 1 + .github/pull_request_template.md | 7 ++-- .github/workflows/publish-cloudberry-site.yml | 3 +- .gitmessage | 6 +-- README.md | 56 +++++++++++++-------------- 5 files changed, 35 insertions(+), 38 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index c681c2b8..1a67821d 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -23,6 +23,7 @@ github: - database - greenplum - postgresql + - cloudberry features: # Enable wiki for documentation wiki: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6820f450..1b7d2428 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,9 +14,8 @@ closes: #ISSUE_Number Here are some reminders before you submit your pull request: -* Make sure that your Pull Request has a clear title and commit message. You can take the [Git commit template](https://github.com/cloudberrydb/cloudberrydb/blob/main/.gitmessage) as a reference. -* Sign the Contributor License Agreement as prompted for your first-time contribution (*One-time setup*). +* Make sure that your Pull Request has a clear title and commit message. You can take the [Git commit template](https://github.com/apache/cloudberry/blob/main/.gitmessage) as a reference. * Learn the [code contribution](https://cloudberry.apache.org/contribute/code) and [doc contribution](https://cloudberry.apache.org/contribute/doc) guides for better collaboration. * Make sure that your changes deployment preview is successful. -* List your communications in the [GitHub Issues](https://github.com/cloudberrydb/cloudberrydb-site/issues) or [Discussions](https://github.com/apache/cloudberry/discussions) (if has or needed). -* Feel free to ask for the @cloudberrydb/doc team or other people to help review and approve. +* List your communications in the [GitHub Issues](https://github.com/apache/cloudberry-site/issues) or [Discussions](https://github.com/apache/cloudberry/discussions) (if has or needed). +* Feel free to ask for the [cloudberry committers](https://github.com/orgs/apache/teams/cloudberry-committers) or other people to help review and approve. diff --git a/.github/workflows/publish-cloudberry-site.yml b/.github/workflows/publish-cloudberry-site.yml index 6e762cef..95bf8cbc 100644 --- a/.github/workflows/publish-cloudberry-site.yml +++ b/.github/workflows/publish-cloudberry-site.yml @@ -17,7 +17,8 @@ # publish-cloudberry-site.yml # -# This workflow builds and publishes the Apache CloudBerry website to cloudberry.apache.org +# This workflow builds and publishes the Apache Cloudberry website to +# cloudberry.apache.org. # The site is built using Node.js and published to the asf-site branch, # which Apache infrastructure then serves at cloudberry.apache.org # diff --git a/.gitmessage b/.gitmessage index 7c5ad79a..afd01453 100644 --- a/.gitmessage +++ b/.gitmessage @@ -33,8 +33,8 @@ Add your commit body here #on-behalf-of: @ORG [email protected] # If your commit have clear context included in GitHub Issues or GitHub # Discussions, please list them as a reference: -#See: Issue#id <https://github.com/cloudberrydb/cloudberrydb/issues/?>? -#See: Discussion#id <http://github.com/orgs/cloudberrydb/discussions/>? +#See: Issue#id <https://github.com/apache/cloudberry/issues/?>? +#See: Discussion#id <http://github.com/apache/cloudberry/discussions/>? ######################################################################## # # @@ -44,4 +44,4 @@ Add your commit body here # # # -# +# \ No newline at end of file diff --git a/README.md b/README.md index 50d0e17b..6f95d116 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ ## Apache Cloudberry (Incubating) Website & Documentation -[](https://app.netlify.com/sites/cloudberrydb/deploys) +[](https://cloudberry.apache.org) +[](https://cloudberry.apache.org/docs) [](https://inviter.co/apache-cloudberry) -[](https://x.com/ASFCloudberry) -[](https://cloudberrydb.org) -[](https://github.com/apache/cloudberry/discussions) +[](https://twitter.com/ASFCloudberry) +[](https://cloudberry.apache.org/community/wechat) +[](https://youtube.com/@ApacheCloudberry) --- @@ -13,24 +13,22 @@ Discussions](https://img.shields.io/github/discussions/cloudberrydb/cloudberrydb ``` . +├── LICENSE +├── NOTICE ├── README.md ├── babel.config.js ├── blog ├── docs -├── docusaurus.config.js +├── docusaurus.config.ts +├── global.d.ts ├── i18n -├── LICENSE -├── sidebars.js +├── package-lock.json +├── package.json +├── scripts +├── sidebars.ts ├── src -│ ├── components -│ ├── css -│ ├── pages -│ │ ├── community -│ ├── theme -│ │ ├── Footer ├── static -│ ├── img -│ ├── js +└── tsconfig.json ``` Notable directories Description: @@ -43,28 +41,29 @@ Notable directories Description: 2. Document - The latest version of the document is under the `docs` (en) and `/i18n/zh/docusaurus-plugin-content-docs/current/` (zh). + The latest version of the document is under the `docs` (en) and + `/i18n/zh/docusaurus-plugin-content-docs/current/` (zh). directory. Media including images, video can be placed in `docs/media` folder. You must add the new doc file name to `sidebars.js` to make it display on the website. 3. Pictures - All images are placed in the `static/images` directory. + All images are placed in the `static/img` directory. ## Website Building -This website is built using [Docusaurus 2](https://docusaurus.io/), a +This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator. If you don't know Docusaurus, please learn more from [Docusaurus website](https://docusaurus.io/). -You can follow these steps to install and build the Cloudberry -Database website in your local environment. +You can follow these steps to install and build the Apache Cloudberry +website in your local environment. 1. Clone website source ``` -$ git clone https://github.com/cloudberrydb/cloudberrydb-site.git +$ git clone https://github.com/apache/cloudberry-site.git ``` 2. Install dependencies @@ -86,13 +85,10 @@ $ npm run serve This command generates static content into the `build` directory and can be served using any static contents hosting service. -If you are using GitHub pages for hosting, this command is a -convenient way to build the website and push to the `gh-pages` branch. - Then you can visit `localhost:3000` in the browser. -4. (Option)If you want to run the local development environment, - please run: +4. (Option) If you want to run the local development environment, you + can skip Step 3 to run the following command directly: ``` $ npm run start @@ -106,10 +102,10 @@ server. Our documents are still in construction, welcome to help. If you're interested in [document -contribution](https://cloudberrydb.org/community/docs-contributing-guide), +contribution](https://cloudberry.apache.org/community/docs-contributing-guide), you can submit the pull request -[here](https://github.com/cloudberrydb/cloudberrydb-site/tree/main/docs). +[here](https://github.com/apache/cloudberry-site/tree/main/docs). # License -Apache License Version 2.0(see LICENSE & NOTICE). \ No newline at end of file +Apache License Version 2.0 (see LICENSE & NOTICE). --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
