Skip to content

docs: Updated build steps using profiles in Developer Setup#18312

Open
rangareddy wants to merge 1 commit intoapache:asf-sitefrom
rangareddy:update_developer_setup
Open

docs: Updated build steps using profiles in Developer Setup#18312
rangareddy wants to merge 1 commit intoapache:asf-sitefrom
rangareddy:update_developer_setup

Conversation

@rangareddy
Copy link
Collaborator

Describe the issue this Pull Request addresses

The current Developer Setup documentation does not clearly mention the Maven profiles required when building the project locally. This can lead to confusion for new contributors when trying to compile the project or run tests. This PR updates the documentation to explicitly mention the relevant build profiles and how they should be used during the build process.

Summary and Changelog

This PR improves the developer documentation by clarifying the build instructions and including the Maven profiles required during the build process.

Changes included:

  • Updated the Developer Setup build instructions to include the relevant Maven profiles.
  • Improved clarity around the build commands used by contributors.
  • Ensured that the documentation reflects the recommended way to build the project locally.

These changes make it easier for developers to successfully build the project without confusion.

Impact

None

Risk Level

None

Documentation Update

The Developer Setup documentation has been updated to clearly mention the Maven build profiles used during the build process.

Contributor's checklist

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

@rangareddy rangareddy requested a review from danny0405 March 12, 2026 06:58
@github-actions github-actions bot added docs size:XS PR with lines of changes in <= 10 labels Mar 12, 2026
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 raising this. Please update README.md as well

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.

Did not realise earlier that you raised a separate PR for README changes. Only one comment and it should be good to merge

@rangareddy
Copy link
Collaborator Author

Thank you for raising this. Please update README.md as well

Yes i have raised separate PR for README.md file.

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

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants