Skip to content

Commit bc0d0b8

Browse files
authored
Move /data section to README (#15)
* Remove mermaid * Move Data section to README * Update README * Restructure links and README * Move example queries * Final README tweaks
1 parent dfcf57e commit bc0d0b8

7 files changed

Lines changed: 387 additions & 2704 deletions

File tree

README.md

Lines changed: 371 additions & 2 deletions
Large diffs are not rendered by default.

site/assets/css/main.scss

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -206,20 +206,6 @@ ol {
206206
font-weight: bold;
207207
}
208208
}
209-
210-
.mermaid {
211-
display: flex;
212-
justify-content: center;
213-
align-items: center;
214-
background-color: transparent;
215-
border: none;
216-
padding: 0;
217-
218-
svg {
219-
width: 100%;
220-
margin: auto;
221-
}
222-
}
223209
}
224210

225211
.link-nowrap-nodec {

site/assets/vendor/mermaid-11.4.1.min.js

Lines changed: 0 additions & 2313 deletions
This file was deleted.

site/content/about.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for free and with no limits.
1111
All times are calculated using open-source software from publicly available
1212
data. The OpenTimes data pipelines, infrastructure, packages, and website
1313
are all open-source and available on [GitHub](https://github.com/dfsnow/opentimes).
14-
See the [Data]({{< ref "data" >}}) section to learn how to download the data.
14+
See the [README](https://github.com/dfsnow/opentimes#getting-the-data) to learn how to download the data.
1515

1616
### Goals
1717

@@ -34,8 +34,8 @@ performing live routing, etc.).
3434
## FAQs
3535

3636
This section focuses on the what, why, and how of the OpenTimes project. For
37-
more specific questions about the data (i.e. its coverage, structure, and
38-
limitations), see the [Data]({{< ref "data" >}}) section.
37+
more specific questions about the data (i.e. its coverage, structure,
38+
and limitations), see the project [README](https://github.com/dfsnow/opentimes#opentimes).
3939

4040
<details>
4141
<summary>General questions</summary>
@@ -45,19 +45,18 @@ limitations), see the [Data]({{< ref "data" >}}) section.
4545
In this case, a travel time is just how long it takes to get from location A
4646
to location B while following a road or path network. Think Google Maps or
4747
your favorite smartphone mapping service. OpenTimes provides billions of these
48-
times, all pre-calculated from public data. However, unlike a smartphone map,
48+
times, all pre-calculated from public data. However, unlike a smartphone,
4949
OpenTimes does not provide the route itself, only the time between the two
5050
points.
5151

5252
#### What are the times between?
5353

5454
Times are between the _population-weighted_ centroids of United States Census
55-
geographies. See [Data]({{< ref "data" >}}) for a full list of geographies.
56-
Centroids are weighted because sometimes Census geographies are huge and their
57-
unweighted centroid is in the middle of a desert or mountain range. However,
58-
most people don't want to go to the desert, they want to go to where other
59-
people are. Weighting the centroids moves them closer to where people actually
60-
want to go (i.e. towns and cities).
55+
geographies. Centroids are weighted because sometimes Census geographies are
56+
huge and their unweighted centroid is in the middle of a desert or mountain
57+
range. However, most people don't want to go to the desert, they want to go
58+
to where other people are. Weighting the centroids moves them closer to where
59+
people actually want to go (i.e. towns and cities).
6160

6261
#### What travel modes are included?
6362

@@ -145,8 +144,8 @@ can access a list of all the files [here](https://data.opentimes.org).
145144
Files can be downloaded directly, queried with DuckDB or Arrow, or accessed
146145
via the (forthcoming) R or Python wrapper packages.
147146

148-
To learn more about how to access the data, see the dedicated
149-
[Data]({{< ref "data" >}}) section.
147+
To learn more about how to access the data, see the
148+
[GitHub README](https://github.com/dfsnow/opentimes#opentimes).
150149

151150
#### How much does this all cost to host?
152151

@@ -203,7 +202,7 @@ Attribution is required when using OpenTimes data.
203202
Please see the
204203
[CITATION file on GitHub](https://github.com/dfsnow/opentimes/blob/master/CITATION.cff).
205204
You can also generate APA and BibTeX citations directly from the
206-
[GitHub project](https://github.com/dfsnow/opentimes) page.
205+
project's [GitHub page](https://github.com/dfsnow/opentimes#opentimes).
207206

208207
#### What license do you use?
209208

@@ -233,6 +232,9 @@ I built most of OpenTimes during a six-week programming retreat at the
233232
[Recurse Center](https://www.recurse.com/scout/click?t=e5f3c6558aa58965ec2efe48b1b486af),
234233
which I highly recommend.
235234

235+
If you need to contact me about this project, please
236+
reach out [via email](mailto:info@opentimes.org).
237+
236238
### Why did you build this?
237239

238240
A few reasons:

0 commit comments

Comments
 (0)