Skip to content

Commit d6dcc8b

Browse files
authored
style: fix minor typos in the README (#57)
1 parent 3a8ec25 commit d6dcc8b

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,34 @@
88

99
This repo hosts components of the dbt Fusion engine, the foundation for future innovation in `dbt`. The dbt Fusion engine is written in Rust and is designed for speed, correctness, and has a native understanding of SQL across multiple data warehouse SQL dialects.
1010

11-
> [!IMPORTANT]
11+
> [!IMPORTANT]
1212
> **Note: the dbt Fusion Engine is in Beta!**
13-
Bugs and missing functionality compared to dbt Core will be resolved continuously in the leadup to a final release (see [this post](https://docs.getdbt.com/blog/fusion-path-to-ga) for more details).
13+
Bugs and missing functionality compared to dbt Core will be resolved continuously in the lead-up to a final release (see [this post](https://docs.getdbt.com/blog/fusion-path-to-ga) for more details).
1414

15-
The dbt Fusion engine is a ground up, first principles rewrite of the dbt Core execution engine, built to be interoperable with the standard dbt authoring layer. Fusion enforces some ambiguous areas of the authoring spec more strictly than dbt Core to ensure correctness (for example, dbt Core does not proactively validate most YAML configurations). Many of these discrepancies can be fixed automatically with the [dbt Autofix](https://github.com/dbt-labs/dbt-autofix) tool.
15+
The dbt Fusion engine is a ground-up, first principles rewrite of the dbt Core execution engine, built to be interoperable with the standard dbt authoring layer. Fusion enforces some ambiguous areas of the authoring spec more strictly than dbt Core to ensure correctness (for example, dbt Core does not proactively validate most YAML configurations). Many of these discrepancies can be fixed automatically with the [dbt Autofix](https://github.com/dbt-labs/dbt-autofix) tool.
1616

1717
Beyond conformance with dbt Core, Fusion also contains new SQL Comprehension capabilities, a language server, modern ADBC drivers for warehouse connections, and more. While dbt Core was written in Python, the dbt Fusion engine is written in Rust, and compiled to a single application binary.
1818

19-
You can install dbt-fusion onto your local machine, a docker container, or a machine in the cloud. It is designed for flexible installation, with no dependencies on other libraries. The only libraries that dbt Fusion will load are it's corresponding database drivers.
19+
You can install dbt-fusion onto your local machine, a docker container, or a machine in the cloud. It is designed for flexible installation, with no dependencies on other libraries. The only libraries that dbt Fusion will load are its corresponding database drivers.
2020

2121
The dbt Fusion engine is being released to this repository incrementally, so, until this note is removed this repository contains only a subset of the crates that make the core of the engine work. These crates are published incrementally starting on May 28.
2222

2323
## Getting Started with the dbt Fusion engine
2424

25-
> [!TIP]
26-
> You don't have to build this project from source to use the new dbt! We recommend using the precompiled binary with additional capabilities:
25+
> [!TIP]
26+
> You don't have to build this project from source to use the new dbt! We recommend using the precompiled binary with additional capabilities:
2727
28-
There are several ways to get started with Fusion (for more, see dbt Fusion's quickstart documentation [here](https://docs.getdbt.com/guides/fusion?step=1))
29-
1. **Download dbt the vs-code extension** - For most people the best experience. This will install the dbt fusion CLI and Language Server on your system - see the install guide [here](https://docs.getdbt.com/docs/install-dbt-extension).
30-
2. **Install Fusion Directly** Install just the fusion CLI with the command below or see dbt's documentation [here](https://docs.getdbt.com/docs/fusion/install-fusion)
28+
There are several ways to get started with Fusion (for more, see dbt Fusion's quickstart documentation [here](https://docs.getdbt.com/guides/fusion?step=1)):
29+
1. **Download the dbt VS Code extension** - For most people the best experience. This will install the dbt fusion CLI and Language Server on your system - see the install guide [here](https://docs.getdbt.com/docs/install-dbt-extension).
30+
2. **Install Fusion Directly** - Install just the fusion CLI with the command below or see dbt's documentation [here](https://docs.getdbt.com/docs/fusion/install-fusion)
3131
``` bash
3232
curl -fsSL https://public.cdn.getdbt.com/fs/install/install.sh | sh -s -- --update
3333
```
3434
3. **Build Fusion from Source** - See the *Compiling from Source* section below
3535

3636

3737
### Supported Operating Systems and CPU Microarchitectures
38-
Fusion & associated drivers are compiled for each CPU microarchitecture and operating system independently. This allows for hardware level optimization.
38+
Fusion & associated drivers are compiled for each CPU microarchitecture and operating system independently. This allows for hardware-level optimization.
3939

4040
Legend:
4141
* 🟢 - Supported today
@@ -62,12 +62,12 @@ Legend:
6262
### Top Level Components Released to Date
6363
Releases of various Fusion components will be iterative as each component reaches maturity & readiness for contribution.
6464

65-
- [x] `dbt-jinja` - All Rust extension of mini-jinja to support dbt's jinja functions & other capabilities
65+
- [x] `dbt-jinja` - A Rust extension of mini-jinja to support dbt's jinja functions & other capabilities
6666
- [x] `dbt-parser` - Rust parser for dbt projects
6767
- [x] `dbt-snowflake` - database driver
6868
- [x] `dbt-schemas` - complete, correct, machine generated json schemas for dbt's authoring surface
6969
- [ ] `dbt-sql` - ANTLR grammars and generated parsers
70-
- [ ] snowflake.g4
70+
- [ ] snowflake.g4
7171
- [ ] bigquery.g4
7272
- [ ] redshift.g4
7373
- [ ] databricks.g4
@@ -76,9 +76,9 @@ Releases of various Fusion components will be iterative as each component reache
7676
## FAQ
7777

7878
<details>
79-
<summary><i>Can I con contribute to the dbt Fusion engine?</i></summary>
79+
<summary><i>Can I contribute to the dbt Fusion engine?</i></summary>
8080

81-
Yes absolutely!. Please see our contribution guidelines [here](CONTRIBUTING.md)
81+
Yes, absolutely! Please see our contribution guidelines [here](CONTRIBUTING.md)
8282
</details>
8383

8484
<details>
@@ -87,20 +87,20 @@ Releases of various Fusion components will be iterative as each component reache
8787
*Things that are the same:*
8888
* The YML authoring format including profiles, configuration, seeds, data tests, and unit tests
8989
* The materialization libraries
90-
* dbt's library managemenet system (although `dbt deps` are installed automatically)
90+
* dbt's library management system (although `dbt deps` are installed automatically)
9191

9292
*Additional capabilities provided by Fusion:*
9393
* All new Arrow Database Connector (ADBC) drivers for faster data transfers and unified connection handling
9494
* A language server and corresponding VS-Code extension (compatible with Cursor) for ease of development
9595
* Multi-dialect SQL compilation, validation, & static analysis
96-
* Standalone distribution. No JVM, or python required.
96+
* Standalone distribution. No JVM, or Python required.
9797
* Automatic installation of dependencies, whether that's a dbt package, or database driver
9898
* dbt code-signed & secure distributions
9999
</details>
100100

101101
<details>
102102
<summary><i>This repo doesn't have all of dbt's functionality, when will the rest come?</i></summary>
103-
dbt Fusion's source code is being published as components are finalized. Please see the Timeline section above
103+
dbt Fusion's source code is being published as components are finalized. Please see the Timeline section above.
104104
</details>
105105

106106
<details>
@@ -117,7 +117,7 @@ Releases of various Fusion components will be iterative as each component reache
117117

118118
## Compiling from Source
119119

120-
The primary CLI in this repository is the `dbt-sa-cli`. To compile the CLI, you need the Rust toolchain.
120+
The primary CLI in this repository is the `dbt-sa-cli`. To compile the CLI, you need the Rust toolchain.
121121

122122
Let's start with Rust, run the following command to install Rust on your machine:
123123

@@ -151,9 +151,9 @@ Options:
151151
...
152152
```
153153

154-
Cargo is Rust's build system and package manager. If you're familiar with Python, pip would be a sufficient comparison. We'll use cargo to run command to build the local `dbt-sa-cli` binary and run helper scripts via `cargo xtask`. More on that later.
154+
Cargo is Rust's build system and package manager. If you're familiar with Python, pip would be a sufficient comparison. We'll use cargo to run commands to build the local `dbt-sa-cli` binary and run helper scripts via `cargo xtask`. More on that later.
155155

156-
To build the binary locally, `cd` to the this repo's directory and run:
156+
To build the binary locally, `cd` to this repo's directory and run:
157157

158158
```shell
159159
cargo build
@@ -188,14 +188,14 @@ cd target/debug && pwd
188188
To run tests, increase the stack size and use nextest.
189189

190190
```
191-
RUST_MIN_STACK=8388608 cargo nextest run --no-fail-fast
191+
RUST_MIN_STACK=8388608 cargo nextest run --no-fail-fast
192192
```
193193

194194
# License
195-
The dbt Fusion engine is a monorepo and contains more than one License. Most code is licensed under ELv2. For more, please see our [licenses](LICENSES.md) section.
195+
The dbt Fusion engine is a monorepo and contains more than one license. Most code is licensed under ELv2. For more, please see our [licenses](LICENSES.md) section.
196196

197197
# Acknowledgments
198-
*To the dbt community:* dbt the tool & dbt Labs the company would not be here without the incredible community of authors, contributors, practitioners, and enthusiasts. dbt Fusion is an evolution of that work & stands on the shoulders of what has come before.
198+
*To the dbt community:* dbt the tool & dbt Labs the company would not be here without the incredible community of authors, contributors, practitioners, and enthusiasts. dbt Fusion is an evolution of that work & stands on the shoulders of what has come before.
199199

200200
*To the Arrow Community:* dbt Labs is committing fully to the Arrow ecosystem. Fusion exclusively uses the Arrow type system from drivers through adapters into the internals of the compiler & runtime.
201201

0 commit comments

Comments
 (0)