-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Duplicated content in Readme and User Guide -- should we consolidate #1400
Comments
I think it's enough to keep |
I agree -- good point to keep the README highlighting key points, especially as the README.md text turns into the documentation on the crates.io homepage: https://crates.io/crates/datafusion |
+1 from me for moving big chunk of content to our website and keep only the key highlights in readme. We can convert some of the key highlights into different datafusion website links in readme as well to further reduce duplication. |
How's this going? Maybe we can add a |
added tag |
Describe the bug
There appears to be duplicated content / overlap between
https://github.com/apache/arrow-datafusion/blob/master/docs/source/user-guide/ (which is eventually published to https://arrow.apache.org/datafusion/ )
and https://github.com/apache/arrow-datafusion/blob/master/README.md
I worry that the content is diverging (e.g. with the list of supported SQL)
Expected behavior
I wonder if it would ok to move all content from and https://github.com/apache/arrow-datafusion/blob/master/README.md into the users guide and change README.md to have a link to the user guide?
The text was updated successfully, but these errors were encountered: