Skip to content
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

Closed
alamb opened this issue Dec 4, 2021 · 6 comments · Fixed by #1745
Closed

Duplicated content in Readme and User Guide -- should we consolidate #1400

alamb opened this issue Dec 4, 2021 · 6 comments · Fixed by #1745
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alamb
Copy link
Contributor

alamb commented Dec 4, 2021

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?

@alamb alamb added bug Something isn't working documentation Improvements or additions to documentation labels Dec 4, 2021
@alamb
Copy link
Contributor Author

alamb commented Dec 4, 2021

Any thoughts @houqp / @jimexist ?

@xudong963
Copy link
Member

I think it's enough to keep Datafusion, Use Cases, Why DataFusion?, Known Uses, Example Usage, Using DataFusion as a library, Using DataFusion as a binary, Roadmap, Architecture Overview, Developer's guide in README (maybe fewer parts), others will be better to move into user guide. Then README will be concise and highlight the key points.

@alamb
Copy link
Contributor Author

alamb commented Dec 5, 2021

I think it's enough to keep Datafusion, Use Cases, Why DataFusion?, Known Uses, Example Usage, Using DataFusion as a library, Using DataFusion as a binary, Roadmap, Architecture Overview, Developer's guide in README (maybe fewer parts), others will be better to move into user guide. Then README will be concise and highlight the key points.

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

@houqp
Copy link
Member

houqp commented Dec 5, 2021

+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.

@xudong963
Copy link
Member

How's this going? Maybe we can add a good first issue tag.

@alamb alamb added the good first issue Good for newcomers label Dec 30, 2021
@alamb
Copy link
Contributor Author

alamb commented Dec 30, 2021

added tag

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants