Move configuration information out of example usage page #11300
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
Jul 6, 2024
| @@ -41,13 +41,16 @@ DataFusion offers SQL and Dataframe APIs, excellent | |||
| CSV, Parquet, JSON, and Avro, extensive customization, and a great | |||
| community. | |||
|
|
|||
| To get started with examples, see the `example usage`_ section of the user guide and the `datafusion-examples`_ directory. | |||
| To get started, see | |||
There was a problem hiding this comment.
I also added a link to the library user guide as well as making this into a bullet list so it is easier to see what options are available
alamb
force-pushed
the
alamb/simplify_usage
branch
from
4f71a6d
to
53b2bea
Compare
alamb
commented
Jul 7, 2024
| If you haven't reviewed the [architecture section in the docs][docs], it's a | ||
| useful place to get the lay of the land before starting down a specific path. | ||
|
|
||
| DataFusion is designed to be extensible at all points, including |
There was a problem hiding this comment.
This was random content that was on the "getting started" page that I moved into the library user guide as it seemed a bette rhome
| @@ -33,29 +33,6 @@ datafusion = "latest_version" | |||
| tokio = { version = "1.0", features = ["rt-multi-thread"] } | |||
| ``` | |||
|
|
|||
| ## Add latest non published DataFusion dependency | |||
There was a problem hiding this comment.
I moved all this content to other more appropriate locations
alamb
force-pushed
the
alamb/simplify_usage
branch
from
53b2bea
to
24027eb
Compare
github-actions
bot
removed
the
documentation
jonahgao
approved these changes
Jul 11, 2024
|
|
||
| ## Enable backtraces | ||
|
|
||
| By default Datafusion returns errors as a plain message. There is option to enable more verbose details about the error, |
There was a problem hiding this comment.
Suggested change
| By default Datafusion returns errors as a plain message. There is option to enable more verbose details about the error, | |
| By default DataFusion returns errors as a plain message. There is option to enable more verbose details about the error, |
| ## Enable backtraces | ||
|
|
||
| By default Datafusion returns errors as a plain message. There is option to enable more verbose details about the error, | ||
| like error backtrace. To enable a backtrace you need to add Datafusion `backtrace` feature to your `Cargo.toml` file: |
There was a problem hiding this comment.
Suggested change
| like error backtrace. To enable a backtrace you need to add Datafusion `backtrace` feature to your `Cargo.toml` file: | |
| like error backtrace. To enable a backtrace you need to add DataFusion `backtrace` feature to your `Cargo.toml` file: |
Lordworms
pushed a commit
to Lordworms/arrow-datafusion
that referenced
this pull request
Jul 12, 2024
findepi
pushed a commit
to findepi/datafusion
that referenced
this pull request
Jul 16, 2024
xinlifoobar
pushed a commit
to xinlifoobar/datafusion
that referenced
this pull request
Jul 17, 2024
xinlifoobar
pushed a commit
to xinlifoobar/datafusion
that referenced
this pull request
Jul 18, 2024
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?
Part of #11172
Rationale for this change
The current example usage page https://datafusion.apache.org/user-guide/example-usage.html contains a mix of getting started examples as well as more advanced options such as patching in new datafusion versions
I think this would be easier for people to find if they were split into two separate pages
What changes are included in this PR?
Move some of the more advanced usage examples to a new page called "Crate Configuration"
Are these changes tested?
I manually looked at them
Are there any user-facing changes?
No, doc changes only