Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: merge docs for CBDB compilation on Linux systems #224

Merged
merged 1 commit into from
Oct 30, 2023

Conversation

TomShawn
Copy link
Contributor

@TomShawn TomShawn commented Sep 27, 2023

The docs for compiling CBDB on Linux systems are distributed in 2 files: readmes/README.Linux.md and readmes/README.md. This is not user-friendly enough. This PR merges the content into one document for a better reading experience.


Change logs

Describe your change clearly, including what problem is being solved or what feature is being added.

If it has some breaking backward or forward compatibility, please clary.

Why are the changes needed?

Describe why the changes are necessary.

Does this PR introduce any user-facing change?

If yes, please clarify the previous behavior and the change this PR proposes.

How was this patch tested?

Please detail how the changes were tested, including manual tests and any relevant unit or integration tests.

Contributor's Checklist

Here are some reminders and checklists before/when submitting your pull request, please check them:

  • Make sure your Pull Request has a clear title and commit message. You can take git-commit template as a reference.
  • Sign the Contributor License Agreement as prompted for your first-time contribution(One-time setup).
  • Learn the coding contribution guide, including our code conventions, workflow and more.
  • List your communication in the GitHub Issues or Discussions (if has or needed).
  • Document changes.
  • Add tests for the change
  • Pass make installcheck
  • Pass make -C src/test installcheck-cbdb-parallel
  • Feel free to @cloudberrydb/dev team for review and approval when your PR is ready馃コ

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiiii, @TomShawn welcome!馃帄 Thanks for taking the effort to make our project better! 馃檶 Keep making such awesome contributions!

@TomShawn
Copy link
Contributor Author

@tuhaihe @Zhangbaowen-Hashdata PTAL, thanks!

Copy link
Member

@tuhaihe tuhaihe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

  1. Could you update your commit title by following our commit conventions?

  2. Do we need to update the readmes/README.md file?

readmes/README.Linux.md Outdated Show resolved Hide resolved
@TomShawn TomShawn force-pushed the merge-linux-compile-docs branch 2 times, most recently from e7ecb91 to 1a2c244 Compare September 28, 2023 02:57
@tuhaihe tuhaihe changed the title docs: merge docs for CBDB compilation on Linux systems Doc: merge docs for CBDB compilation on Linux systems Oct 26, 2023
readmes/README.Linux.md Outdated Show resolved Hide resolved
@TomShawn TomShawn force-pushed the merge-linux-compile-docs branch 2 times, most recently from 141dba7 to 8df0831 Compare October 26, 2023 05:59
tuhaihe
tuhaihe previously approved these changes Oct 26, 2023
Copy link
Member

@tuhaihe tuhaihe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

readmes/README.Linux.md Outdated Show resolved Hide resolved
The docs for compiling CBDB on Linux systems are distributed in 2 files:
readmes/README.Linux.md and readmes/README.md. This is not user-friendly
enough.

This PR merges the content into one document for a better reading
experience.
Copy link
Contributor

@my-ship-it my-ship-it left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@my-ship-it my-ship-it merged commit 5a1fff5 into cloudberrydb:main Oct 30, 2023
6 checks passed
@TomShawn TomShawn deleted the merge-linux-compile-docs branch October 30, 2023 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants