-
Notifications
You must be signed in to change notification settings - Fork 13
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
Source updates, usage tagging #110
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.
Say when it's been deprecated, please.
README.md
Outdated
@@ -40,6 +40,10 @@ While a source .json file in the `whosonfirst-sources` repository does not requi | |||
|
|||
* `"description":` A one to two sentence description of the source (_string, optional property_). | |||
|
|||
* `"mz:is_current":` Represents whether of not a source is currently in use (_string, optional property_). `0` signifies "not current". | |||
|
|||
* `"edtf:deprecated":` Indicates the date when a place was determined to be invalid, was never a "going concern" (_string, optional property_). _Format: YYYY-MM-DD (though these dates can be encoded with any valid EDTF syntax)_. |
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.
Source, not 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.
bin/docs.py
Outdated
@@ -52,6 +52,10 @@ | |||
if details.get('description'): | |||
docs.write("_%s_ \n\n" % (details['description'])) | |||
|
|||
if details.get('edtf:deprecated'): | |||
if not details['edtf:deprecated'] == 'uuuu': | |||
docs.write("* %s\n" % ('This source has been deprecated.')) |
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.
Also Indicate the date, please.
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.
Also, for these that were deprecated ( |
I'm not seeing usage for YS, please make sure you're looking for any |
Should we be tracking what placetypes are covered by this source? Other sources without usage:
|
#110 (comment) fixed in 4a3c3e3 |
|
source_template.json
Outdated
@@ -8,8 +8,11 @@ | |||
"license": "", | |||
"license_type": "", | |||
"license_text": "", | |||
"src:via": {"Whos On First":"https://whosonfirst.org/"}, |
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 update template for new list of "well known" objects format.
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.
#110 (comment) taken care of in 9c3ff4f |
9c3ff4f taken care of in #110 (comment) Notes: There are several sources not in the Updated usage keys for:
Added usage key, but the source is not yet in use (in PR):
Unable to find concordance, property, or geometry usage for:
Deprecated:
No change, correct as is:
Updated minor spacing issue:
Other:
|
#110 (comment) taken care of in 22c6a2b |
@nvkelso - all comments should be addressed in this PR. A few notes:
|
I’m fine with that.
… On May 21, 2018, at 16:48, Stephen Epps ***@***.***> wrote:
@nvkelso - all comments should be addressed in this PR. A few notes:
We have deprecated the name, addr, geom, and lbl property prefixes and pointed to their json files in the properties repo. There are three other properties catalogued, though.. osm. edtf, and lieu. I suggest keeping osm because it is used as a concordance value in some records, but deprecating lieu and edtf and pointing to their json files in the properties repo. Thoughts?
Follow-ups are being tracked in #98
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
bin/docs.py
Outdated
docs.write("\n This source includes `CC-BY compatible` data from the following organizations:\n") | ||
for via in details['src:via']: | ||
if via['source_note']: | ||
docs.write(" \t* **%s**: [%s](%s) - %s\n" % (via["context"],via["source_name"],via["source_link"],via["source_note"])) |
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.
Can you add a test for a link and only add the markdown link decorations if there is a link, please?
Here and one down.
For
|
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.
Great work! 🎉
Fixes #97, #40, #113, and #114 .
Also includes a few minor tweaks to the README,
docs.py
and source json files. Includes:Added
mz:is_current
andedtf:deprecated
property descriptions to the README. Similar descriptions to what is found in the properties repo repo.Updated the
docs.py
script to include logic to write out "This source has been deprecated." if anedtf:deprecated
property has been set.Added a
mz:is_current
andedtf:deprecated
property toaddr
,geom
,lbl
andname
json files, as these are not sources (they're catalogued in the properties repo)Added description to
lbl
json, for consistencyCrawled the repo and appended values to the
usage:*
properties for each json file in the repo. Running the makefile added the usage tags to each source in the sources/README fileAdds
src:via
property to three json sources. These are lists of sources, the key being the source name, value being the source website (not all are included yet).Updated the
docs.py
to write out a list of each "via" source in the README (see Quattroshapes).Updated template file to include new potential properties.
Note that most of the json files have large diffs. This is due to all of the property keys being sorted when writing back to disc. The properties are now alphabetized - I can wire this into the makefile if helpful.