docs: Update developer setup guide and refresh IDE setup screenshots#14251
docs: Update developer setup guide and refresh IDE setup screenshots#14251xushiyan merged 6 commits intoapache:asf-sitefrom
Conversation
xushiyan
left a comment
There was a problem hiding this comment.
examine the default values for the project, like java 11 should be the new default, similar for all other versions spark, flink, scala, etc.
Review what is redundant, e.g. if the info is available in readme or not. this page should be extending what is in the readme for people to start. And readme should have a link to this page
keep intellij section to a later part, move more commonly useful sections up. there are too many screenshots for intellij section, keep less important things collapsed to make the page shorter to scroll
These changes aim to improve readability and overall structure of the setup guide. |
|
@xushiyan @deepakpanda93 any progress on updating this PR? |
c4199fa to
69267dd
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates the developer setup guide to reflect the current environment requirements and reorganizes the documentation for better clarity. The changes include updating Java version requirements, adding a new default build profiles section, and restructuring the IntelliJ IDE setup instructions using collapsible sections.
Key Changes:
- Updated Java requirement from JDK 8 to JDK 11, and default Spark profile from 3.2 to 3.5
- Added a new "Default Build Profiles" table summarizing Spark 3.5, Scala 2.12, Java 11, and Flink 1.20 as defaults
- Reorganized IntelliJ setup instructions into collapsible sections and moved them after the code walkthrough section for better flow
Reviewed changes
Copilot reviewed 1 out of 14 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/contribute/developer-setup.md | Updated system requirements, default build profiles, Maven command examples, and reorganized IDE setup instructions with collapsible sections for better readability |
| website/static/assets/images/contributing/IDE_setup_java.png | Refreshed screenshot showing Java 11 configuration in IntelliJ Project Structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Describe the issue this Pull Request addresses
This PR updates the developer setup guide to ensure it reflects the latest environment configuration and dependencies. It also refreshes the IDE setup screenshots for better clarity.
Summary and Changelog
Impact
None
Risk Level
none
Documentation Update
This PR adds new documentation content.
Contributor's checklist