Skip to content

Commit fef3939

Browse files
committed
fix up links in readme
1 parent 9cb0e1d commit fef3939

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ data-diff is a **free, open-source tool** that enables data professionals to det
99

1010
## Documentation
1111

12-
[**🗎 Documentation website**](https://docs.datafold.com/os_diff/about) - our detailed documentation has everything you need to start diffing.
12+
[**🗎 Documentation**](https://docs.datafold.com/reference/open_source) - our detailed documentation has everything you need to start diffing.
1313

1414
### Databases we support
1515

@@ -27,7 +27,7 @@ data-diff is a **free, open-source tool** that enables data professionals to det
2727
- DuckDB >=0.6
2828
- SQLite (coming soon)
2929

30-
For their corresponding connection strings, check out our [detailed table](https://docs.datafold.com/os_diff/databases_we_support).
30+
For their corresponding connection strings, check out our [detailed table](https://docs.datafold.com/reference/open_source/cli#connection-methods).
3131

3232
#### Looking for a database not on the list?
3333
If a database is not on the list, we'd still love to support it. [Please open an issue](https://github.com/datafold/data-diff/issues) to discuss it, or vote on existing requests to push them up our todo list.
@@ -92,7 +92,7 @@ Once you've installed `data-diff`, you can run it from the command line.
9292
data-diff DB1_URI TABLE1_NAME DB2_URI TABLE2_NAME [OPTIONS]
9393
```
9494

95-
Be sure to read [the docs](https://docs.datafold.com/os_diff/how_to_use/how_to_use_with_command_line) for detailed instructions how to build one of these commands depending on your database setup.
95+
Be sure to read [the docs](https://docs.datafold.com/reference/open_source/cli) for detailed instructions how to build one of these commands depending on your database setup.
9696

9797
#### Code Example: Diff Tables Between Databases
9898
Here's an example command for your copy/pasting, taken from the screenshot above when we diffed data between Snowflake and Postgres.
@@ -110,8 +110,6 @@ data-diff \
110110

111111
#### Code Example: Diff Tables Within a Database
112112

113-
Here's a code example from [the video](https://www.loom.com/share/682e4b7d74e84eb4824b983311f0a3b2), where we compare data between two Snowflake tables within one database.
114-
115113
```
116114
data-diff \
117115
"snowflake://<username>:<password>@<password>/<DATABASE>/<SCHEMA_1>?warehouse=<WAREHOUSE>&role=<ROLE>" <TABLE_1> \
@@ -130,18 +128,13 @@ In both code examples, I've used `<>` carrots to represent values that **should
130128

131129
We know that in some cases, the data-diff command can become long and dense. And maybe you're new to the command line.
132130

133-
* We're here to help [on slack](https://locallyoptimistic.slack.com/archives/C03HUNGQV0S) if you have ANY questions as you use `data-diff` in your workflow.
131+
* We're here to help [on slack](https://getdbt.slack.com/archives/C03D25A92UU) if you have ANY questions as you use `data-diff` in your workflow.
134132
* You can also post a question in [GitHub Discussions](https://github.com/datafold/data-diff/discussions).
135133

136-
137-
To get a Slack invite - [click here](https://locallyoptimistic.com/community/)
138-
139134
## How to Use
140135

141-
* [How to use from the shell (or: command-line)](https://docs.datafold.com/os_diff/how_to_use/how_to_use_with_command_line)
142-
* [How to use from Python](https://docs.datafold.com/os_diff/how_to_use/how_to_use_with_python)
143-
* [How to use with TOML configuration file](https://docs.datafold.com/os_diff/how_to_use/how_to_use_with_toml)
144-
* [Usage Analytics & Data Privacy](https://docs.datafold.com/os_diff/usage_analytics_data_privacy)
136+
* [How to use from the shell (or: command-line)](https://docs.datafold.com/reference/open_source/cli)
137+
* [How to use from Python](https://data-diff.readthedocs.io/en/latest/python-api.html)
145138

146139
## How to Contribute
147140
* Feel free to open an issue or contribute to the project by working on an existing issue.
@@ -155,7 +148,7 @@ Big thanks to everyone who contributed so far:
155148

156149
## Technical Explanation
157150

158-
Check out this [technical explanation](https://docs.datafold.com/os_diff/technical_explanation) of how data-diff works.
151+
Check out this [technical explanation](https://github.com/datafold/data-diff/blob/master/docs/technical-explanation.md) of how data-diff works.
159152

160153
## License
161154

0 commit comments

Comments
 (0)