Skip to content

docs: add direnv-based local dev setup + fix tsal.md link#31

Open
kevinsoucy wants to merge 1 commit into
databrickslabs:mainfrom
kevinsoucy:docs/direnv-and-tsal-link
Open

docs: add direnv-based local dev setup + fix tsal.md link#31
kevinsoucy wants to merge 1 commit into
databrickslabs:mainfrom
kevinsoucy:docs/direnv-and-tsal-link

Conversation

@kevinsoucy
Copy link
Copy Markdown

Ship a project-scoped .envrc that activates Java 17, the venv, and the PySpark interpreter when contributors cd into the repo. Uses $(brew --prefix openjdk@17) so the path resolves on both Apple Silicon and Intel macOS.

Document the flow in CONTRIBUTING.md, including a manual source .envrc fallback for contributors who can't use direnv.

Also fix a broken relative link in docs/impulse/docs/references/tsal.md (missing .md extension; trips MkDocs strict mode).

Ship a project-scoped .envrc that activates Java 17, the venv, and the
PySpark interpreter when contributors cd into the repo. Uses
$(brew --prefix openjdk@17) so the path resolves on both Apple Silicon
and Intel macOS.

Document the flow in CONTRIBUTING.md, including a manual `source .envrc`
fallback for contributors who can't use direnv.

Also fix a broken relative link in docs/impulse/docs/references/tsal.md
(missing .md extension; trips MkDocs strict mode).

Co-authored-by: Isaac
@kevinsoucy kevinsoucy requested a review from a team as a code owner May 22, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant