Skip to content

enhancement(docs): Add user guide (#432)#445

Merged
alamb merged 1 commit into
apache:mainfrom
mesejo:enhacement/new-users-guide
Aug 10, 2023
Merged

enhancement(docs): Add user guide (#432)#445
alamb merged 1 commit into
apache:mainfrom
mesejo:enhacement/new-users-guide

Conversation

@mesejo
Copy link
Copy Markdown
Contributor

@mesejo mesejo commented Aug 4, 2023

Which issue does this PR close?

Closes #432

What changes are included in this PR?

This PR includes additional changes in the documentation to make it coherent with the User Guide and the documentation from the DataFusion main project

Are there any user-facing changes?

Yes, the documentation page will change.

@mesejo
Copy link
Copy Markdown
Contributor Author

mesejo commented Aug 4, 2023

To make it easier to review, I can try to deploy the documentation at ReadTheDocs.

@jdye64
Copy link
Copy Markdown
Contributor

jdye64 commented Aug 4, 2023

I am always a fan of doc contribs! I'm going to read through this over the next few days to check for validity and give a formal review. However, doesn't matter still love when people contribute docs! Thanks @mesejo. Just wanted to let you know I will be looking at it.

@alamb
Copy link
Copy Markdown
Contributor

alamb commented Aug 7, 2023

@MrPowers would you have time to give this a look as well?

@mesejo mesejo force-pushed the enhacement/new-users-guide branch 3 times, most recently from 08b7856 to d5e8c49 Compare August 7, 2023 16:02
Copy link
Copy Markdown
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read this document and it is really nice @mesejo -- thank you very much

I had a few small comments, but I think they could be done in follow on PRs too.

Comment thread docs/source/user-guide/introduction.rst Outdated
Comment thread docs/source/user-guide/basics.rst Outdated
Comment thread docs/source/user-guide/common-operations/aggregations.rst
Comment thread docs/source/user-guide/basics.rst
@mesejo mesejo force-pushed the enhacement/new-users-guide branch from d5e8c49 to 82fb72c Compare August 9, 2023 18:13
@alamb alamb merged commit e34d203 into apache:main Aug 10, 2023
@alamb
Copy link
Copy Markdown
Contributor

alamb commented Aug 10, 2023

Thanks again @mesejo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New users guide

3 participants