Skip to content

docs: Update developer setup guide and refresh IDE setup screenshots#14251

Merged
xushiyan merged 6 commits intoapache:asf-sitefrom
deepakpanda93:br_update_dev_setup_page
Jan 10, 2026
Merged

docs: Update developer setup guide and refresh IDE setup screenshots#14251
xushiyan merged 6 commits intoapache:asf-sitefrom
deepakpanda93:br_update_dev_setup_page

Conversation

@deepakpanda93
Copy link
Collaborator

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

  • Updated developer-setup.md with the latest installation and configuration steps.
  • Replaced outdated screenshots showing IDE setup (IntelliJ).

Impact

None

Risk Level

none

Documentation Update

This PR adds new documentation content.

Contributor's checklist

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

@github-actions github-actions bot added docs size:S PR with lines of changes in (10, 100] labels Nov 12, 2025
@deepakpanda93 deepakpanda93 requested a review from yihua November 24, 2025 07:09
@xushiyan xushiyan removed the docs label Dec 2, 2025
@github-actions github-actions bot added the docs label Dec 2, 2025
Copy link
Member

@xushiyan xushiyan left a comment

Choose a reason for hiding this comment

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

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

@deepakpanda93
Copy link
Collaborator Author

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

@xushiyan

  • Added a Default Profile section for better clarity.
  • Reordered the content to keep commonly used commands at the top for quick access.
  • Moved the IntelliJ-specific configuration to a later section to improve flow.
  • Removed lower-priority setup images to keep the documentation concise.

These changes aim to improve readability and overall structure of the setup guide.

@github-actions github-actions bot added size:M PR with lines of changes in (100, 300] and removed size:S PR with lines of changes in (10, 100] labels Dec 16, 2025
@yihua
Copy link
Contributor

yihua commented Jan 9, 2026

@xushiyan @deepakpanda93 any progress on updating this PR?

@xushiyan xushiyan force-pushed the br_update_dev_setup_page branch from c4199fa to 69267dd Compare January 10, 2026 00:04
@xushiyan xushiyan marked this pull request as ready for review January 10, 2026 00:16
Copilot AI review requested due to automatic review settings January 10, 2026 00:16
@xushiyan xushiyan merged commit c7e0bf2 into apache:asf-site Jan 10, 2026
5 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

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

Labels

docs size:M PR with lines of changes in (100, 300]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants