First pass of documentation in mdBook #364
Conversation
|
mdBook generates docs that are really nice-looking. Excited to collaborate on the team with next steps! |
docs/mdbook/book.toml
Outdated
| @@ -0,0 +1,6 @@ | |||
| [book] | |||
| authors = ["Matthew Powers"] | |||
There was a problem hiding this comment.
Can we change this to something like this:
authors = ["Apache Arrow <[email protected]>"]
docs/mdbook/src/installation.md
Outdated
|
|
||
| ## Examples | ||
|
|
||
| See the [pydata-examples](https://github.com/MrPowers/pydata-examples) for a variety of Jupyter notebooks that show DataFusion in action! |
There was a problem hiding this comment.
Could we link to an example in this repo?
There was a problem hiding this comment.
Changed this to the examples in this repo, which feels more appropriate.
|
|
||
| It's easy to create DataFusion tables from a variety of data sources. | ||
|
|
||
| ## Create table from Python Dictionary |
There was a problem hiding this comment.
Do we want to capitalize "table" here and the following sections?
There was a problem hiding this comment.
Good catch, updated throughout.
| @@ -0,0 +1,17 @@ | |||
| # DataFusion Book | |||
There was a problem hiding this comment.
We will need to add ASF headers to all of these .md files:
| # DataFusion Book | |
| <!--- | |
| Licensed to the Apache Software Foundation (ASF) under one | |
| or more contributor license agreements. See the NOTICE file | |
| distributed with this work for additional information | |
| regarding copyright ownership. The ASF licenses this file | |
| to you under the Apache License, Version 2.0 (the | |
| "License"); you may not use this file except in compliance | |
| with the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, | |
| software distributed under the License is distributed on an | |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| KIND, either express or implied. See the License for the | |
| specific language governing permissions and limitations | |
| under the License. | |
| --> | |
| # DataFusion Book |
There was a problem hiding this comment.
Added the license throughout.
|
Thanks @MrPowers this looks like a great start. I left some feedback. |
|
Thanks for the review @andygrove. Feel free to comment with any other next steps and I'll be happy to continue updating this PR. |
|
@MrPowers two more files need ASF headers: NOT APPROVED: docs/mdbook/README.md (./docs/mdbook/README.md): false |
|
Thanks @andygrove, made those updates. |
Which issue does this PR close?
Closes #339.
Rationale for this change
The documentation is currently in sphinx, which is challenging to update (requires RST, not markdown) and has bad default settings for SEO/usability. Migrating the documentation to mdBook will make it easier to build an amazing user guide.
What changes are included in this PR?
A folder that generates a mdBook documentation site.
Are there any user-facing changes?
No, this just changed the documentation. No code changes.