-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation after stat var migration #174
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for all these fixes!
could you update your editor settings to only update lint / whitespace in files with modifications?
please also note in the PR description that some obsolete pages are deleted
api/python/place_in.md
Outdated
@@ -1,7 +1,7 @@ | |||
--- | |||
layout: default | |||
title: Places within a Place | |||
nav_order: 10 | |||
title: Places Within a Place |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please revert the capitalization of "within" for consistency (anne was careful to follow the google documentation style guide)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
title: Places within a Place | ||
nav_order: 10 | ||
title: Places Within a Place | ||
nav_order: 6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any reason to update the nav ordering?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are some duplicate nav_order entries which gave random order in final pages. Also the order should be updated as many pages have been removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gotcha, sg
api/python/query.md
Outdated
These examples and errors, along with explanations and fixes for the errors, are available in this [notebook](https://colab.research.google.com/drive/1Jd0IDHnMdtxhsmXhL5Ib5tL0zgJud1k5?usp=sharing). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These examples and errors, along with explanations and fixes for the errors, are available in this [notebook](https://colab.research.google.com/drive/1Jd0IDHnMdtxhsmXhL5Ib5tL0zgJud1k5?usp=sharing). | |
These examples and errors, along with explanations and fixes for the errors, are available in this [Python notebook](https://colab.research.google.com/drive/1Jd0IDHnMdtxhsmXhL5Ib5tL0zgJud1k5?usp=sharing). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
api/rest/place_in.md
Outdated
@@ -1,7 +1,7 @@ | |||
--- | |||
layout: default | |||
title: Places within a Place | |||
nav_order: 9 | |||
title: Places Within a Place |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please revert
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
api/sheets/places_in.md
Outdated
@@ -1,7 +1,7 @@ | |||
--- | |||
layout: default | |||
title: Places within a Place | |||
nav_order: 5 | |||
title: Places Within a Place |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please revert
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
data_model.md
Outdated
1. The data model for the base layer is the one used by [Schema.org](https://schema.org). This models the world as a set of entities, with attributes and relationships between entities. There is a taxonomy of entities and each entity is an instance of at least one of the types in the taxonomy. The types and relations types are also entities. This kind of structure has its origins in knowledge representation systems such as KRL and Cyc, and has recently found adoption under the name 'knowledge graph'. The [Node and SPARQL APIs](/api) provide access to this view. The [Data Commons Graph Browser](https://datacommons.org/browser) allows one to browse through Data Commons in this raw graph view | ||
1. Time series view provides a set of time series for combinations of entities and variables ([Statistical Varables](https://datacommons.org/browser/StatisticalVariable), in Data Commons parlance). The [DCGet API](/api/sheets/get_variable.html) provides API access to this view of the data and the [Data Commons Timelines Tool](https://datacommons.org/tools/timelines) allows one to browse Data Commons in this view. | ||
1. The data model for the base layer is the one used by [Schema.org](https://schema.org). This models the world as a set of entities, with attributes and relationships between entities. There is a taxonomy of entities and each entity is an instance of at least one of the types in the taxonomy. The types and relations types are also entities. This kind of structure has its origins in knowledge representation systems such as KRL and Cyc, and has recently found adoption under the name "knowledge graph". The [Node and SPARQL APIs](/api) provide access to this view. The [Data Commons Graph Browser](https://datacommons.org/browser) allows one to browse through Data Commons in this raw graph view | ||
1. Time series view provides a set of time series for combinations of entities and variables ([Statistical Varable](https://datacommons.org/browser/StatisticalVariable), in Data Commons parlance). The [DCGET API](/api/sheets/get_variable.html) provides API access to this view of the data and the [Data Commons Timeline Tool](https://datacommons.org/tools/timeline) allows one to browse Data Commons in this view. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Time series view provides a set of time series for combinations of entities and variables ([Statistical Varable](https://datacommons.org/browser/StatisticalVariable), in Data Commons parlance). The [DCGET API](/api/sheets/get_variable.html) provides API access to this view of the data and the [Data Commons Timeline Tool](https://datacommons.org/tools/timeline) allows one to browse Data Commons in this view. | |
1. Time series view provides a set of time series for combinations of entities and variables ([Statistical Variable](https://datacommons.org/browser/StatisticalVariable), in Data Commons parlance). The [DCGET API](/api/sheets/get_variable.html) provides API access to this view of the data and the [Data Commons Timeline Tool](https://datacommons.org/tools/timeline) allows one to browse Data Commons in this view. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
|
||
A complete list of properties can be found at <https://datacommons.org/browser/scalingFactor>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please keep this line, even if redundant. the headings don't look very clickable at the moment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added this back to be consistent with other items
glossary.md
Outdated
The unit of measurement. Examples include [kilowatt hours](https://datacommons.org/browser/KilowattHour), [inches](https://datacommons.org/browser/Inch), and [Indian Rupees](https://datacommons.org/browser/IndianRupee). A complete list of properties can be found in the [browser](https://datacommons.org/browser/unit). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The unit of measurement. Examples include [kilowatt hours](https://datacommons.org/browser/KilowattHour), [inches](https://datacommons.org/browser/Inch), and [Indian Rupees](https://datacommons.org/browser/IndianRupee). A complete list of properties can be found in the [browser](https://datacommons.org/browser/unit). | |
The unit of measurement. Examples include [kilowatt hours](https://datacommons.org/browser/KilowattHour), [inches](https://datacommons.org/browser/Inch), and [Indian Rupees](https://datacommons.org/browser/IndianRupee). A complete list of properties can be found in the [graph browser](https://datacommons.org/browser/unit). |
glossary.md
Outdated
@@ -10,51 +10,49 @@ This page contains a selection of key terms important to understanding the struc | |||
|
|||
## Term List | |||
|
|||
- **[Cohort](http://browser.datacommons.org/kg?dcid=CohortSet)** | |||
### **[Cohort](https://datacommons.org/browser/CohortSet)** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the bold might not be necessary if it is now also a heading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we make the links clearer by making it separate from the heading? e.g.
Cohort (graph node)
or
Cohort
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. Updated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the updates!
Thanks for review! |
No description provided.