Move content from README.md to docs site #5824
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alamb
commented
Apr 1, 2023
| @@ -50,11 +50,11 @@ A "major" PR means there is a substantial change in design or a change in the AP | |||
| 3. Non-controversial build-related changes (clippy, version upgrades etc.) | |||
| 4. Smaller non-controversial feature additions | |||
|
|
|||
| # Developer's guide | |||
| ## Getting Started | |||
There was a problem hiding this comment.
I changed some of these heading levels so they didn't all appear in the main table of contents on https://arrow.apache.org/datafusion/
| - [Databend](https://github.com/datafuselabs/databend) is a complete | ||
| database system. Like DataFusion it is also written in Rust and | ||
| utilizes the Apache Arrow memory model, but unlike DataFusion it | ||
| targets end-users rather than developers of other database systems. |
There was a problem hiding this comment.
If someone who knew more about Apache Calcite wanted to add a note here that would also be awesome
| @@ -27,176 +29,8 @@ in-memory format. | |||
|
|
|||
| DataFusion offers SQL and Dataframe APIs, excellent [performance](https://benchmark.clickhouse.com/), built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and a great community. | |||
|
|
|||
| [](https://codecov.io/gh/apache/arrow-datafusion?branch=master) | |||
There was a problem hiding this comment.
The point of this PR is to move all this content into the docs directory. Some was already partially replicated
alamb
commented
Apr 1, 2023
| under the License. | ||
| --> | ||
|
|
||
| # Architecture |
There was a problem hiding this comment.
I am working on an update to this content -- #4990
andygrove
approved these changes
Apr 3, 2023
jackwener
approved these changes
Apr 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #5755
Rationale for this change
I would like the DataFusion documentation to get better. One problem, as described on #5755, is that there are effectively 2 doc sites (the README in the repository as well as the https://arrow.apache.org/datafusion/)
While https://arrow.apache.org/datafusion/ still needs some significant love, getting more eyes on it will make that more obvious and having a single place to focus documentation effort will improve our efficiency.
And thanks to @martin-g 's work on #5500 the website is not weeks out of date with the github repo ❤️
I plan several more PRs to update the website content
What changes are included in this PR?
Are these changes tested?
N/A
Are there any user-facing changes?
Hopefully better docs