docs: Add instruction to build#14694
Conversation
github-actions
bot
added
the
documentation
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you so much @dentiny -- this is much apreciated
It seems like we have most of this content already -- see https://datafusion.apache.org/contributor-guide/getting_started.html but clearly it isn't easy enough to find
I have some other thought on making this easier to find. What do you think?
- Rename the "Getting Started" page to "Development Environment" or something like that
- Add a link to that page at the top of the introduciton page: https://datafusion.apache.org/contributor-guide/index.html
Thanks again for helping make the docs better
| Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that. | ||
| Commenting on the PR will remove the `stale` label. | ||
|
|
||
| ## Building |
There was a problem hiding this comment.
Thank you @dentiny -- I think most of this information is already present in this page:
https://datafusion.apache.org/contributor-guide/getting_started.html
Would you be willing to combine your contribution with the existing information there?
There was a problem hiding this comment.
I think most of this information is already present in this page:
Ohhhh my bad! I didn't find it's the subpage for contributing page...
There was a problem hiding this comment.
I removed instructions for build, they're already included in the existing dev env doc;
Keep some sentence for setting dev container for easier operation.
dentiny
force-pushed
the
hjiang/instruction-to-build
branch
from
71b9bd6 to
b35ef7c
Compare
dentiny
force-pushed
the
hjiang/instruction-to-build
branch
from
b35ef7c to
3072000
Compare
Both sounds good to me! |
| 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. | ||
|
|
||
| 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). |
There was a problem hiding this comment.
thanks @dentiny for your contribution
Couple of notes
- referring to VSCode probably can be misleading as not all engineers using it.
- Not sure why dev containers are needed for the development
There was a problem hiding this comment.
referring to VSCode probably can be misleading as not all engineers using it.
Ok, I will remove. Add it because vscode is pretty popular.
Not sure why dev containers are needed for the development
Devcontainer is a easy-setup datafusion provides, otherwise you need to manually prepare a clean environment.
* Add instruction to build * format readme doc and rename getting started * Add instruction for devcontainer * remove dev container and vscode part
|
I think we forgot to update the index name too: |
4 participants
Which issue does this PR close?
Rationale for this change
Add better instruction for new-comers to build the project.
Are these changes tested?
I manually verified the build steps work on my end.