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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: update the building guide for MacOS #220

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Conversation

Baowen648
Copy link
Contributor

@Baowen648 Baowen648 commented Sep 25, 2023

closes: #ISSUE_Number


Change logs

We changed the related documents of cbdb deployment on macos, updated the content of the documents, modified the documents from the aspects of environmental deployment, compilation and installation, and optimized the macos documents with the assistance of document students.

Why are the changes needed?

Ensure that the documentation is accurate and usable

Does this PR introduce any user-facing change?

According to the documents needed by the users can quickly build on MacOS environment

How was this patch tested?

By manually executing the instructions in the readme, it can quickly build cbdb and verify whether it is available

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.
  • 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🥳

@Baowen648
Copy link
Contributor Author

The README.macos.md document has been uploaded successfully, please check it out and give some suggestions.Thank you!
@tuhaihe @TomShawn @Ray-Eldath

@Ray-Eldath
Copy link
Contributor

This need to be merged after #201 and #198 be merged.

Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

rest LGTM

readmes/README.macOS.md Outdated Show resolved Hide resolved
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.

Could you please rewrite the commit message that pertains to this PR? This will help ensure the clarity and accuracy of the message. Thank you.

@Baowen648 Baowen648 force-pushed the main branch 2 times, most recently from ada499f to 84d2d6a Compare September 25, 2023 10:51
readmes/README.macOS.md Outdated Show resolved Hide resolved
readmes/README.macOS.md Outdated Show resolved Hide resolved
readmes/README.macOS.md Outdated Show resolved Hide resolved
@Baowen648 Baowen648 force-pushed the main branch 3 times, most recently from 37f980c to e00ed85 Compare September 26, 2023 06:31
@Ray-Eldath Ray-Eldath self-requested a review September 26, 2023 10:46
Copy link
Contributor

@Ray-Eldath Ray-Eldath left a comment

Choose a reason for hiding this comment

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

on hold this for a while.

tuhaihe
tuhaihe previously approved these changes Sep 27, 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.

@tuhaihe LGTM.

baotingfang
baotingfang previously approved these changes Sep 27, 2023
readmes/README.macOS.md Outdated Show resolved Hide resolved
readmes/README.macOS.md Outdated Show resolved Hide resolved
Our team has thoroughly reviewed and significantly improved the
documentation for the macOS system. We have left no stone unturned
in our efforts to ensure that our instructions for setting up the
Mac development environment, compiling and installing cbdb, and
verifying the cluster are crystal clear. We have conducted
extensive testing on version 13.4+ on various chips, including
intel, M1, and M2, and have confirmed that all of them are capable
of flawlessly executing the aforementioned functions.
@tuhaihe tuhaihe self-requested a review September 28, 2023 01:51
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.

@tuhaihe Approved.

@my-ship-it my-ship-it merged commit 09438ab into apache:main Sep 28, 2023
5 checks passed
baotingfang pushed a commit that referenced this pull request Dec 1, 2023
Our team has thoroughly reviewed and significantly improved the
documentation for the macOS system. We have left no stone unturned
in our efforts to ensure that our instructions for setting up the
Mac development environment, compiling and installing cbdb, and
verifying the cluster are crystal clear. We have conducted
extensive testing on version 13.4+ on various chips, including
intel, M1, and M2, and have confirmed that all of them are capable
of flawlessly executing the aforementioned functions.
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.

6 participants