mirror of
https://github.com/langchain-ai/delta-rs.git
synced 2026-07-01 20:34:35 -04:00
docs: minor updates to the readme and contributing
- GH has a built in TOC - Made some headings more parallel - Improve docs workflow in contributing Signed-off-by: Sam Wright <samuel@plaindocs.com>
This commit is contained in:
committed by
R. Tyler Croy
parent
91a8abb595
commit
b028721318
+26
-10
@@ -8,7 +8,7 @@ If you want to start contributing, first look at our good first issues: https://
|
||||
|
||||
If you want to contribute something more substantial, see our "Projects seeking contributors" section on our roadmap: https://github.com/delta-io/delta-rs/issues/1128
|
||||
|
||||
## AI-generated code
|
||||
## Using AI-generated code
|
||||
|
||||
We recognise that AI coding assistants are now a regular part of many
|
||||
developers' workflows and can improve productivity. Thoughtful use of these
|
||||
@@ -52,7 +52,7 @@ If you want to claim an issue to work on, you can write the word `take` as a com
|
||||
|
||||
## Quick start
|
||||
|
||||
- Install Rust, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html)
|
||||
- Install Rust, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
|
||||
- Install the [uv Python package manager](https://docs.astral.sh/uv/getting-started/installation/).
|
||||
|
||||
- Build the project for development. This will install `deltalake` into the Python virtual environment managed by uv.
|
||||
@@ -72,16 +72,29 @@ If you want to claim an issue to work on, you can write the word `take` as a com
|
||||
cargo run --example basic_operations --features="datafusion"
|
||||
```
|
||||
|
||||
## Run the docs locally
|
||||
*This serves your local contents of docs via a web browser, handy for checking what they look like if you are making changes to docs or docstings*
|
||||
## Running the docs locally
|
||||
|
||||
```sh
|
||||
(cd python; make develop)
|
||||
pip install -r docs/requirements.txt
|
||||
mkdocs serve
|
||||
```
|
||||
Preview your doc and docstring changes in a web browser:
|
||||
|
||||
## To make a pull request (PR)
|
||||
- Install [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html).
|
||||
- Install the [uv Python package manager](https://docs.astral.sh/uv/getting-started/installation/).
|
||||
|
||||
- Build the project for development. This will install `deltalake` into the Python virtual environment managed by uv.
|
||||
```sh
|
||||
cd python
|
||||
make develop
|
||||
```
|
||||
|
||||
- From the root directory, activate the uv environment and install the Python docs requirements.
|
||||
```sh
|
||||
cd ..
|
||||
source python/.venv/bin/activate
|
||||
pip install -r docs/requirements.txt
|
||||
```
|
||||
|
||||
- Run `mkdocs serve` to preview your doc changes at http://127.0.0.1:8000/delta-io/delta-rs/.
|
||||
|
||||
## Making a pull request (PR)
|
||||
Make sure all the following steps run/pass locally before submitting a PR
|
||||
|
||||
```sh
|
||||
@@ -94,6 +107,9 @@ make unit-test
|
||||
make build-docs
|
||||
```
|
||||
|
||||
Note that all commits to `delta-rs` should be [signed](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s), pull requests should be in lower case,
|
||||
and conform to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
|
||||
|
||||
## Developing in VSCode
|
||||
|
||||
*These are just some basic steps/components to get you started, there are many other very useful extensions for VSCode*
|
||||
|
||||
@@ -54,17 +54,6 @@ API that lets you query, inspect, and operate your Delta Lake with ease.
|
||||
[crates]: https://crates.io/crates/deltalake
|
||||
[crates-dl]: https://img.shields.io/crates/d/deltalake?color=F75101
|
||||
|
||||
## Table of contents
|
||||
|
||||
- [Table of contents](#table-of-contents)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Get Involved](#get-involved)
|
||||
- [Integrations](#integrations)
|
||||
- [Features](#features)
|
||||
- [Cloud Integrations](#cloud-integrations)
|
||||
- [Supported Operations](#supported-operations)
|
||||
- [Protocol Support Level](#protocol-support-level)
|
||||
|
||||
## Quick Start
|
||||
|
||||
The `deltalake` library aims to adopt patterns from other libraries in data processing,
|
||||
@@ -105,16 +94,18 @@ async fn main() -> Result<(), DeltaTableError> {
|
||||
}
|
||||
```
|
||||
|
||||
You can also try Delta Lake docker at [DockerHub](https://go.delta.io/dockerhub) | [Docker Repo](https://go.delta.io/docker)
|
||||
You can also try Delta Lake in Docker at [DockerHub](https://go.delta.io/dockerhub) | [Docker Repo](https://go.delta.io/docker)
|
||||
|
||||
## Get Involved
|
||||
|
||||
We encourage you to reach out, and are [committed](https://github.com/delta-io/delta-rs/blob/main/CODE_OF_CONDUCT.md)
|
||||
to provide a welcoming community.
|
||||
The `delta-rs` team is [committed](https://github.com/delta-io/delta-rs/blob/main/CODE_OF_CONDUCT.md)
|
||||
to providing a welcoming community.
|
||||
|
||||
- [Join us in our Slack workspace](https://go.delta.io/slack)
|
||||
- [Report an issue](https://github.com/delta-io/delta-rs/issues/new?template=bug_report.md)
|
||||
- Looking to contribute? See our [good first issues](https://github.com/delta-io/delta-rs/contribute).
|
||||
- [Join us in our Slack workspace](https://go.delta.io/slack).
|
||||
- [Report an issue](https://github.com/delta-io/delta-rs/issues/new?template=bug_report.md).
|
||||
- Looking to contribute?
|
||||
- Read our [contributing guide](COMTRIBUTING.m).
|
||||
- See our [good first issues](https://github.com/delta-io/delta-rs/contribute).
|
||||
|
||||
## Integrations
|
||||
|
||||
|
||||
Reference in New Issue
Block a user