docs: Move existing documentation into new Contributor Guide and add Getting Started section #334
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
andygrove
changed the title
comphead
reviewed
Apr 26, 2024
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
There was a problem hiding this comment.
here I'm thinking to generate this doc automatically the similar to doc/spark_builtin_expr_coverage.txt but in .md format
andygrove
commented
Apr 26, 2024
| 1. Intellij as the Java IDE | ||
| 2. CLion as the Native IDE. For Rust code, the CLion Rust language plugin is required. Note that the | ||
| Intellij Rust plugin is not sufficient. | ||
| Intellij Rust plugin is not sufficient. |
There was a problem hiding this comment.
Formatting changes are from running prettier
viirya
reviewed
Apr 26, 2024
|
|
||
| We maintain a list of good first issues in GitHub [here](https://github.com/apache/datafusion-comet/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). | ||
|
|
||
| The list of currently supported Spark expressions can be found at |
There was a problem hiding this comment.
Thanks. I have removed this.
viirya
reviewed
Apr 26, 2024
| @@ -20,12 +20,13 @@ under the License. | |||
| # Comet Debugging Guide | |||
|
|
|||
| This HOWTO describes how to debug JVM code and Native code concurrently. The guide assumes you have: | |||
|
|
|||
| 1. Intellij as the Java IDE | |||
| 2. CLion as the Native IDE. For Rust code, the CLion Rust language plugin is required. Note that the | |||
There was a problem hiding this comment.
I feel that we can move to RustRover instead of CLion. It is specified for Rust development. We can update this later.
viirya
approved these changes
Apr 26, 2024
viirya
approved these changes
Apr 26, 2024
himadripal
pushed a commit
to himadripal/datafusion-comet
that referenced
this pull request
Sep 7, 2024
…Getting Started section (apache#334)
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 #230
Closes #317
Rationale for this change
The main motivation is to move all docs into the documentation site where it is easier to discover.
I also added a Getting Started section with information about the public Slack and Discord channels and our new regular meetings.
Preview of navigation menu
What changes are included in this PR?
How are these changes tested?