Documentation Tracking List

[TomShawn]

Hello Contributors,

This issue is dedicated to tracking the progress of Cloudberry Database documentation. The goal is to provide a comprehensive and up-to-date documentation for all users, and we appreciate any contributions towards achieving this aim.

The issue will follow the format of a checklist, with each item representing a specific piece of documentation that needs to be added. The item will be checked off once the corresponding Pull Request (PR) has been reviewed and merged.

In addition, each item will be linked to the respective PR for easy reference. This would allow anyone interested to follow the process, review the changes, or participate in the discussion.

Here is the recent plan or progress of adding Cloudberry Database documentation. Note that this list only includes the recently planned docs. Docs that are not present in the list will be added to the list over time.

• Product Introduction

  • Feature Overview. PR: docs: add cbdb feature overview and architecture #13 (cbdb-overview.md)
  • Architecture. PR: docs: add cbdb feature overview and architecture #13 (cbdb-architecture.md)
  • User Scenarios. PR: docs: add cbdb feature overview and architecture #13 (cbdb-scenarios.md)
  • Comparison with Greenplum. PR: docs: add cbdb vs gp in zh and en #11

• Deployment Guides

  • On-Premises Deployment Architecture. PR: Add OP deploy guide docs #15 (cbdb-op-deploy-arch.md)
  • Recommended Hardware and Software Configurations. PR: Add OP deploy guide docs #15 (cbdb-op-software-hardware.md)
  • On-Premises Deployment Guide. PR: Add OP deploy guide docs #15 (cbdb-op-deploy-guide.md) (Reverted)
  • Containerized Deployment Guide.
  • Cloudberry Quick Start Guide.

For contributors looking to assist with this process:

• Please reference this issue in any PRs related to documentation updates.
• Feel free to comment on this issue if you'd like to take up a task, have a suggestion, or need further clarification.

We welcome all forms of contributions (refer to Cloudberry Database Documentation Contribution Guide
) and thank you for your interest in improving the Cloudberry Database documentation!

[github-actions]

Hey, @TomShawn welcome!🎊 Thanks for taking the time to point this out.🙌