Change to Twitter URLs

Joe Wass · Joe Wass · commit 7a7d19483ad6 · 2019-01-10T19:26:19.000Z
diff --git a/docs/history.md b/docs/history.md
@@ -4,11 +4,24 @@ This document describes substantial or breaking changes to the Event Data system
 
 ## Changes
 
-### [2019-01-10] Update Release History page
+### [2019-01-10] Change to Twitter URLs
+ - [event-data-user-guide 1.2.2](https://github.com/CrossRef/event-data-user-guide/releases/tag/1.2.2)
+ - [event-data-agents 0.1.17](https://github.com/CrossRef/event-data-agents/releases/tag/0.1.17) 
+ - [event-investigator 0.1.5](https://github.com/CrossRef/event-data-investigator/releases/tag/0.1.5)
+ 
+New Twitter guidance means that for future Events we are unable to share Tweet URLs. Instead we use custom URIs to express Tweet IDs and author usernames. They still contain all the necessary information to identify the Twitter Content and retrieve the data from the Twitter APIs. Full documentation on the [Twitter Agent](/sources/twitter/) page.  
+
+### [2019-01-10] Update Release History page and copy editing
  - [event-data-user-guide 1.2.1](https://github.com/crossref/event-data-user-guide/tree/1.2.1)
 
 The Release History page now tracks substantial changes to the Event Data Service, not just changes to the documentation. From this point onward it also includes versions of software releases that correspond to changes.
 
+The guide was also reviewed for wording.
+
+## Older changes
+
+Before this point changes only pertain to the documentation.
+
 ### [2018-09-21] Documentation review
  - [event-data-user-guide](https://github.com/crossref/event-data-user-guide) 1.2.0
  
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 # Crossref Event Data
 
-[Version 2.2.0 - Release](/history)
+Version 1.2.2 [Release history](/history)
 
 ## This guide is for everyone
 
diff --git a/docs/sources/twitter.md b/docs/sources/twitter.md
@@ -21,7 +21,7 @@
 
 ## What it is
 
-Twitter users discuss registered content items in tweets. They also retweet others who have discussed registered content items. The Twitter agent monitors a stream of tweets and tries to match DOI links, landing page links, and unlinked DOIs back to registered content items.
+Twitter users discuss registered content items in tweets. They also retweet others who have discussed registered content items. The Twitter agent monitors a stream of tweets and tries to match DOI links, landing page links, and unlinked DOIs back to registered content items. Note that we use a unique URI format when we refer to Tweets.
 
 ## What it does
 
@@ -46,6 +46,46 @@ We then attempt to match all links to registered content items.
 
 ## Example Event
 
+Note that the format of Tweet and author IDs changed in January 2019. They are now non-resolvable URIs. To read a Tweet in your browser, you can visit the URL: 
+
+    http://twitter.com/statuses/«ID»
+
+New format:
+
+    {
+     "license":"https://creativecommons.org/publicdomain/zero/1.0/",
+     "obj_id":"https://doi.org/10.1039/c8ee03134g",
+     "source_token":"45a1ef76-4f43-4cdc-9ba8-5a6ad01cc231",
+     "occurred_at":"2019-01-10T17:12:26Z",
+     "subj_id":"twitter://status?id=1083411254788739073",
+     "id":"29ffcda3-c9bc-47ca-a916-dcde1e2023fa",
+     "evidence_record":"https://evidence.eventdata.crossref.org/evidence/20190110-twitter-28393e6c-03e9-47f8-89ae-584f0d9687f9",
+     "terms":"https://doi.org/10.13003/CED-terms-of-use",
+     "action":"add",
+     "subj":{
+        "pid":"twitter://status?id=1083411254788739073",
+        "url":"twitter://status?id=1083411254788739073",
+        "title":"Tweet 1083411254788739073",
+        "issued":"2019-01-10T17:12:26.000Z",
+        "author":{
+          "url":"twitter://user?screen_name=pmherder"},
+          "original-tweet-url":"twitter://status?id=1083379011089133568",
+          "original-tweet-author":"twitter://user?screen_name=TomBurdyny",
+          "alternative-id":"1083411254788739073"
+        },
+     "source_id":"twitter",
+     "obj":{
+       "pid":"https://doi.org/10.1039/c8ee03134g",
+       "url":"https://pubs.rsc.org/en/Content/ArticleLanding/2019/EE/C8EE03134G",
+       "method":"landing-page-meta-tag",
+       "verification":"checked-url-exact"
+       },
+       "timestamp":"2019-01-10T17:21:51Z",
+       "relation_type_id":"discusses"
+     }
+
+Old style, pre 2019:
+
     {
       "license": "https://creativecommons.org/publicdomain/zero/1.0/",
       "obj_id": "https://doi.org/10.1107/s2052252514014845",
@@ -99,6 +139,8 @@ Events that have been subject to compliance actions will not be included in new
 
 ## Quirks
 
+In January we updated the Agent to use the new URL format. We did not update old Events. You should expect URIs in either format when you use data from this Source.
+
 The rules sent to Gnip PowerTack are manually updated. We aim to keep them in sync with the `domain-list` Artifact, but they may lag slightly.
 
 According to the agreement we have with Twitter, we are allowed to process the text of tweets to extract events but we are not allowed to store or redistribute it. The text of the tweet is therefore passed to the Percolator and marked as 'sensitive'. This means that the SHA1 hash of the text appears in the Evidence Record as an `input-content-hash`, but not the text itself.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,6 +9,7 @@ repo_url: https://github.com/CrossRef/event-data-user-guide
 site_url: https://www.eventdata.crossref.org/guide/
 nav:
  - "Welcome": index.md
+ - "Release history": history.md
  - "Introduction": introduction.md
  - "What's in Event Data?":
    - "About the Data": data/about-the-data.md
@@ -63,4 +64,3 @@ nav:
  - "Appendix: Scholix": app-scholix.md
  - "Appendix: FAQ": app-faq.md
  - "Appendix: Glossary": app-gloss.md
- - "Document history": history.md
