apache/incubator-heron

Update documentation on compiling Heron

Open

#3,453 opened on Feb 13, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (3,636 stars) (620 forks)batch import
good first issuehelp-wanted

Description

The documentation for compiling Heron on Mac is out of date.. It needs to be updated to allow for easier use by the community. This issues is in reference to the issue filed #3452

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of HeronMac OS environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing Mac compilation documentation in the repo (likely in docs/ directory). Cross reference with issue #3452 for specific outdated steps. Consult build scripts (e.g., scripts/) to verify current build process. Update the documentation accordingly and test on a Mac environment if possible.