Skip to content

Commit 71b9bd6

Browse files
committed
format readme doc and rename getting started
1 parent f0e25c3 commit 71b9bd6

File tree

3 files changed

+6
-22
lines changed

3 files changed

+6
-22
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Here are links to some important information
8282

8383
- [Project Site](https://datafusion.apache.org/)
8484
- [Installation](https://datafusion.apache.org/user-guide/cli/installation.html)
85-
- [Rust Getting Started](https://datafusion.apache.org/user-guide/example-usage.html)
85+
- [Rust Development Environment](https://datafusion.apache.org/user-guide/example-usage.html)
8686
- [Rust DataFrame API](https://datafusion.apache.org/user-guide/dataframe.html)
8787
- [Rust API docs](https://docs.rs/datafusion/latest/datafusion)
8888
- [Rust Examples](https://github.com/apache/datafusion/tree/main/datafusion-examples)

docs/source/contributor-guide/getting_started.md renamed to docs/source/contributor-guide/development_environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
under the License.
1818
-->
1919

20-
# Getting Started
20+
# Development Environment
2121

2222
This section describes how you can get started at developing DataFusion.
2323

docs/source/contributor-guide/index.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ In addition to submitting new PRs, we have a healthy tradition of community
3030
members reviewing each other's PRs. Doing so is a great way to help the
3131
community as well as get more familiar with Rust and the relevant codebases.
3232

33+
## Development Environment
34+
35+
You can find how to setup build and testing environment [here](https://datafusion.apache.org/user-guide/example-usage.html)
36+
3337
## Finding and Creating Issues to Work On
3438

3539
You can find a curated [good-first-issue] list to help you get started.
@@ -216,23 +220,3 @@ The good thing about open code and open development is that any issues in one ch
216220

217221
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
218222
Commenting on the PR will remove the `stale` label.
219-
220-
## Building
221-
222-
- To build the project, run `cargo build`; to run all the tests, run `cargo test`.
223-
- One external dependency `protoc` is needed, please install it before build and make sure both executable and protobuf definition accessible
224-
225-
## Dev Container / Github Codespaces
226-
The easiest way to start contributing is via Dev Container. This container works both locally in Visual Studio Code as well as [Github Codespaces](https://github.com/features/codespaces). To open the project in vscode you will need the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). For codespaces you will need to [create a new codespace](https://github.com/apache/datafusion).
227-
228-
With the extension installed you can run the following from the `Command Palette` to get started
229-
```
230-
> Dev Containers: Clone Repository in Container Volume...
231-
```
232-
233-
In the subsequent popup paste the url to the repo and hit enter.
234-
```
235-
https://github.com/apache/datafusion
236-
```
237-
238-
This will create an isolated Workspace in vscode, including all tools and environment variables required to build, test and run.

0 commit comments

Comments
 (0)