Skip to content

docs: Updating the build instructions by mentioning profiles in READM…#18310

Open
rangareddy wants to merge 2 commits intoapache:masterfrom
rangareddy:update_build_instructions
Open

docs: Updating the build instructions by mentioning profiles in READM…#18310
rangareddy wants to merge 2 commits intoapache:masterfrom
rangareddy:update_build_instructions

Conversation

@rangareddy
Copy link
Collaborator

Describe the issue this Pull Request addresses

The current build instructions do not clearly mention the Maven profiles required when building the project. This can lead to confusion for developers who are trying to build the project locally or customize the build for different environments. This PR updates the documentation to explicitly mention the relevant Maven profiles used during the build process.

Summary and Changelog

This PR improves the build documentation by adding details about the Maven profiles required when building the project.

Changes included:

  • Updated the build instructions to mention the relevant Maven profiles.
  • Clarified how developers should use these profiles when running the build commands.
  • Improved documentation clarity to help new contributors successfully build the project locally.

Impact

This change only affects documentation. The update helps developers better understand the build process and reduces potential confusion when building the project.

Risk Level

none

This change only updates documentation and does not affect code execution or system behavior.

Documentation Update

The build instructions have been updated to clearly mention the Maven profiles required during the build process. No additional configuration or feature documentation changes are required.

Contributor's checklist

  • Read through contributor's guide
  • Enough context is provided in the sections above
  • Adequate tests were added if applicable

Copy link
Contributor

@pratyakshsharma pratyakshsharma left a comment

Choose a reason for hiding this comment

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

Thank you for this PR. Minor comments only

Co-authored-by: Pratyaksh Sharma <pratyaksh13@gmail.com>
@hudi-bot
Copy link
Collaborator

CI report:

Bot commands @hudi-bot supports the following commands:
  • @hudi-bot run azure re-run the last Azure build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS PR with lines of changes in <= 10

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants