Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit b75b1c9

Browse files
authored
Merge pull request #266 from leoebfolsom/update-readme-howtouse-links
link to docs and incorporate roman/gerard feedback
2 parents e661d5e + 0789208 commit b75b1c9

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

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

1010
_Are you a developer with a deep understanding of databases and solid Python knowledge? [We're hiring!](https://www.datafold.com/careers)_
1111

12-
[**Check out our documentation!**](https://docs.datafold.com/os_diff/about)
12+
## Documentation
13+
14+
[**Our detailed documentation**](https://docs.datafold.com/os_diff/about) has everything you need to start diffing.
1315

1416
## Use cases
1517

@@ -20,7 +22,7 @@ _Are you a developer with a deep understanding of databases and solid Python kno
2022
<img alt="diff2" src="https://user-images.githubusercontent.com/1799931/196754998-a88c0a52-8751-443d-b052-26c03d99d9e5.png" />
2123
</p>
2224

23-
### Diff Tables Within a Database (available in pre release)
25+
### Diff Tables Within a Database (available in pre-release)
2426
#### Improve code reviews by identifying data problems you don't have tests for
2527
<p align="center">
2628
<a href=https://www.loom.com/share/682e4b7d74e84eb4824b983311f0a3b2 target="_blank">
@@ -77,7 +79,7 @@ Once you've installed `data-diff`, you can run it from the command line.
7779
data-diff DB1_URI TABLE1_NAME DB2_URI TABLE2_NAME [OPTIONS]
7880
```
7981

80-
Be sure to read [the How to Use section below](#how-to-use) which gets into specific details about how to build one of these commands depending on your database setup.
82+
Be sure to read [the docs](https://docs.datafold.com/os_diff/how_to_use) for detailed instructions how to build one of these commands depending on your database setup.
8183

8284
#### Code Example: Diff Tables Between Databases
8385
Here's an example command for your copy/pasting, taken from the screenshot above when we diffed data between Snowflake and Postgres.
@@ -113,24 +115,28 @@ In both code examples, I've used `<>` carrots to represent values that **should
113115

114116
### We're here to help!
115117

116-
We know, that in some cases, the data-diff command can become long and dense. And maybe you're new to the command line.
118+
We know that in some cases, the data-diff command can become long and dense. And maybe you're new to the command line.
119+
120+
* 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.
121+
* You can also post a question in [GitHub Discussions](https://github.com/datafold/data-diff/discussions).
117122

118-
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.
119123

120124
To get a Slack invite - [click here](https://locallyoptimistic.com/community/)
121125

122126
## How to Use
123127

124-
[How to use from the shell (or: command-line)](https://data-diff.readthedocs.io/en/latest/how-to-use.html#how-to-use-from-the-shell-or-command-line)
125-
126-
[How to use from Python](https://data-diff.readthedocs.io/en/latest/how-to-use.html#how-to-use-from-python)
128+
* [How to use from the shell (or: command-line)](https://docs.datafold.com/os_diff/how_to_use#how-to-use-from-the-command-line)
129+
* [How to use from Python](https://docs.datafold.com/os_diff/how_to_use#how-to-use-from-python)
130+
* [Usage Analytics & Data Privacy](https://docs.datafold.com/os_diff/usage_analytics_data_privacy)
127131

128-
[Usage Analytics & Data Privacy](https://data-diff.readthedocs.io/en/latest/how-to-use.html#usage-analytics-data-privacy)
132+
## How to Contribute
133+
* Feel free to open an issue or contribute to the project by working on an existing issue.
134+
* Please read the [contributing guidelines](https://github.com/leoebfolsom/data-diff/blob/master/CONTRIBUTING.md) to get started.
129135

130136

131137
## Technical Explanation
132138

133-
See here: https://data-diff.readthedocs.io/en/latest/technical-explanation.html
139+
Check out this [technical explanation](https://docs.datafold.com/os_diff/technical_explanation) of how data-diff works.
134140

135141
## License
136142

0 commit comments

Comments
 (0)