From 25bd746729134171599471b6d7f9863ce2736232 Mon Sep 17 00:00:00 2001 From: Bruce Ritchie Date: Sun, 5 Jan 2025 22:06:59 +0000 Subject: [PATCH] Added references to IDE documentation for dev containers along with a small note about why one may choose to do development using a dev container. --- docs/source/contributor-guide/getting_started.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/contributor-guide/getting_started.md b/docs/source/contributor-guide/getting_started.md index 5d85e07f3eaa4..a4938ead433b6 100644 --- a/docs/source/contributor-guide/getting_started.md +++ b/docs/source/contributor-guide/getting_started.md @@ -30,6 +30,18 @@ git-bash.exe cargo build ``` +## Dev Container setup + +DataFusion has support for [dev containers](https://containers.dev/) which may be used for +developing DataFusion in an isolated environment either locally or remote if desired. Using dev containers for developing +DataFusion is not a requirement by any means but is available for those where doing local development could be tricky +such as with Windows and WSL2, those with older hardware, etc. + +For specific details on IDE support for dev containers see the documentation for [Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/containers), +[IntelliJ IDEA](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html), +[Rust Rover](https://www.jetbrains.com/help/rust/connect-to-devcontainer.html), and +[GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). + ## Protoc Installation Compiling DataFusion from sources requires an installed version of the protobuf compiler, `protoc`.