From 7114da0a35f04ede7f3b703069189c37d63884a2 Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Wed, 29 Aug 2018 16:48:36 +0200 Subject: [PATCH 1/9] small spelling edits Edits for spelling --- docs/app-faq.md | 14 +++++++------- docs/app-niso.md | 4 ++-- docs/index.md | 9 ++++----- docs/introduction.md | 6 +++--- 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/app-faq.md b/docs/app-faq.md index f25ed1e..55f2786 100644 --- a/docs/app-faq.md +++ b/docs/app-faq.md @@ -3,9 +3,9 @@ [TOC] ### Does Event Data collect data for all DOIs in existence? - + Event Data will accept Events for DOIs issued by any Registration Agency (RA) (for example, DataCite), and will poll for all DOIs in the 'doi-prefix' Artifact (currently Crossref, DataCite in future). Different Agents operate differently, so the data for some sources will be fresher than others. - + ### Which Registration Agencies' DOIs does Event Data use? Event Data is is a joint venture by Crossref and DataCite. It is able to collect DOIs from any DOI Registration Agency (RA), and most Data Sources don't check which RA a DOI belongs to. So in theory, some MEDRA DOIs might end up being included. However, some Data Sources (such as Twitter) target only Crossref and DataCite DOIs. Check the individual Data Sources for full details. @@ -13,7 +13,7 @@ Event Data is is a joint venture by Crossref and DataCite. It is able to collect ### How long is Data available? Once data has entered the Query API it won't be removed (unless under extraordinary circumstances). The data will never 'expire'. - + ### What is an Event? An Event can be described as 'an action that occurs concerning a Registered Content Item'. Every kind of event is slightly different, see the Sources for details. @@ -26,11 +26,11 @@ All APIs use JSON format No, the data available via the Query API is free-of-charge. In the future, we will offer a paid-for Service Level Agreement that will provide more timely access to data. -### Will the data be auditable? +### Can the data be audited? Yes. Event Data is evidence-first and we will supply supporting Evidence for all data that we collect. See [Evidence First](concepts/trustworthiness-and-quality/#evidence-first). -### Can I use the data to feed into my commercial tool? +### Can I use the data to feed into my commercial tool? Yes. We do not clean or aggregate the data we collect so that any commercial vendor has the opportunity to do this themselves in order to use the data in the way which best suits their needs. @@ -44,7 +44,7 @@ Check the [Event Data page](https://www.crossref.org/services-event-data) on the ### How do I access the data? -The Query API is currently the only way to access data. +The Query API is currently the only way to access data. ### Does Event Data work with Multiple Resolution? @@ -52,7 +52,7 @@ We plan to address and clarify how Event Data relates to Multiple Resolution in ### Does Event Data work with DOIs that include emoticons? -Yes. +Yes. ### Will the API make data available in other formats? diff --git a/docs/app-niso.md b/docs/app-niso.md index ef8ea5b..8f7de1e 100644 --- a/docs/app-niso.md +++ b/docs/app-niso.md @@ -10,7 +10,7 @@ Crossref Event Data reports raw Events, not metrics. The [Sources in Depth](sour ### 3: Describe the method(s) by which data are generated or collected and how data are maintained over time. -The Data Contributors section of the User Guide provides a detailed discussion of each Source and exactly what Events from the Source means. +The Data Contributors section of the User Guide provides a detailed discussion of each Source and exactly what Events from the Source means. ### 4: Describe all known limitations of the data. @@ -18,7 +18,7 @@ The Data Contributors section of the User Guide provides a detailed discussion o ### 5: Provide a documented audit trail of how and when data generation and collection methods change over time and list all known effects of these changes. Documentation should note whether changes were applied historically or only from change date forward. -The [Evidence In Depth](evidence-in-depth) section describes the complete audit trail of data, from input to Events, via Evidence Records. It also describes how the Artifact Service shows the complete environment under which an Event was generated. The [Evidence Logs](data/evidence-logs) provide a very high level of detail about every activity and process that took place, including nevative results. +The [Evidence In Depth](evidence-in-depth) section describes the complete audit trail of data, from input to Events, via Evidence Records. It also describes how the Artifact Service shows the complete environment under which an Event was generated. The [Evidence Logs](data/evidence-logs) provide a very high level of detail about every activity and process that took place, including negative results. ### 6: Describe how data are aggregated diff --git a/docs/index.md b/docs/index.md index ef9ad65..ea0572a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,10 +10,10 @@ Crossref Event Data has not yet launched as a production service, but is current - **If you have feedback or a specific use case to share, we'd love to hear from you**. You can email eventdata@crossref.org . - The Beta service is freely available, but we recommend you contact us to register as a Beta tester so we can keep you in the loop. -- The Beta service isn't feature-complete and there may be funtionality mentioned in this Guide that is not yet implemented. +- The Beta service isn't feature-complete and there may be functionality mentioned in this Guide that is not yet implemented. - We cannot guarantee the stability of the Beta service. - All data you collect from Event Data during Beta is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Until Event Data is in production mode though, we do not recommend building any commercial or customer-based tools off the data. -- You may find bugs. If you do, please contact us. +- You may find bugs. If you do, please contact us. ## This guide is for everyone @@ -25,9 +25,9 @@ This Guide is a living document, and if you have questions or suggestions you ca If you're keen to get your hands on the data, you can jump straight to the [Quick Start](https://www.eventdata.crossref.org/guide/service/quickstart/) page. Please bear in mind that the service is in Beta. -All data collected from Event Data is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Every Event will include a `license` link so you know which licence applies to the data, as well as a `terms` link which points to our Terms of Use page where all the information and links you need regarding re-use will be available. Please ensure you read the [Terms of Use](https://www.crossref.org/services/event-data/terms/) before using Event Data. +All data collected from Event Data is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Every Event will include a `license` link so you know which licence applies to the data, as well as a `terms` link which points to our Terms of Use page where all the information and links you need regarding re-use will be available. Please ensure you read the [Terms of Use](https://www.crossref.org/services/event-data/terms/) before using Event Data. -If after the Quick Start you decide to use Event Data, you are strongly encouraged to read the entire Guide. Event Data is an open, flexible service that gathers data from a range of sources. It's important that you understand where the data comes from, how it's processed, and what you should bear in in mind when using it. +If after the Quick Start you decide to use Event Data, you are strongly encouraged to read the entire Guide. Event Data is an open, flexible service that gathers data from a range of sources. It's important that you understand where the data comes from, how it's processed, and what you should bear in in mind when using it. Click the 'Next' button at the bottom of this page to get started... @@ -45,4 +45,3 @@ Click the 'Next' button at the bottom of this page to get started... | 09-Mar-2017 | 0.7.0 | Joe Wass jwass@crossref.org | Complete review of all documentation. Most of it overhauled. | | 06-May-2017 | 1.0.0 | Joe Wass jwass@crossref.org | Beta! | | 06-May-2017 | 1.0.1 | Joe Wass jwass@crossref.org | Add Canonical URLs, Evidence Logs | - diff --git a/docs/introduction.md b/docs/introduction.md index 782105b..bce2d0f 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,6 +1,6 @@ # Introduction -Before the growth of the Web, most discussion around scholarly content stayed in scholarly content, with articles referencing each other. With the growth of online platforms for discussion, publication and social media, we have seen discussions occurr in new, non-traditional places. +Before the growth of the Web, most discussion around scholarly content stayed in scholarly content, with articles referencing each other. With the growth of online platforms for discussion, publication and social media, we have seen discussions occur in new, non-traditional places. The Event Data service captures this activity and acts as a hub for the storage and distribution of this data. The service provides a record of instances where research has been bookmarked, linked, liked, shared, referenced, commented on etc, beyond publisher platforms. For example, when datasets are linked to articles, articles are mentioned on social media or referenced in Wikipedia. @@ -10,7 +10,7 @@ When a relationship is observed between a Crossref-Registered Content Item and a Registered Content is the name we give to items that are registered with Crossref, and to which DOIs have been assigned. This includes Articles, Books and Datasets. When the phrase 'Registered Content Item' is used, you can usually think of a journal article, but be aware that it can apply to any piece of content that was registered with Crossref. -Additionaly, Event Data not only collects this data but also serves as an open platform for third parties to make their own activity data available to everyone. Anyone can build tools, services and research using this platform. +Additionally, Event Data not only collects this data but also serves as an open platform for third parties to make their own activity data available to everyone. Anyone can build tools, services and research using this platform. Event Data Overview @@ -69,7 +69,7 @@ Every Event starts its journey somewhere, usually in an external source. Data fr Crossref Event Data was developed alongside the NISO recommendations for Altmetrics Data Quality Code of Conduct, and we participated in the Data Quality working group. Event Data aims to be an example of openness and transparency. You can read the [Event Data Code of Conduct Self-Reporting table](app-niso.md) in the Appendix. -## Accessing the Data +## Accessing the Data Crossref Event Data is available via our Query API. The Query API allows you to make requests like: From 9a6c7d8cc53689f50869a637fa615b665814430e Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Mon, 3 Sep 2018 16:03:18 +0100 Subject: [PATCH 2/9] edited wordcount.sh added comment --- wordcount.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/wordcount.sh b/wordcount.sh index 969f8aa..00bc790 100755 --- a/wordcount.sh +++ b/wordcount.sh @@ -1 +1,2 @@ +# find total word count find docs | grep '.md' | xargs cat | wc -w From a178b747bf518f725f578aa27c4d282fbf33d516 Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:09:24 +0200 Subject: [PATCH 3/9] Edit on payment in FAQ made this a bit more specific as we are no longer offering a paid service that has more 'timely' data. We will be exploring what to offer instead still and tweaked the wording to reflect this. --- docs/app-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app-faq.md b/docs/app-faq.md index 55f2786..5111cc6 100644 --- a/docs/app-faq.md +++ b/docs/app-faq.md @@ -24,7 +24,7 @@ All APIs use JSON format ### Do I have to pay for the data? -No, the data available via the Query API is free-of-charge. In the future, we will offer a paid-for Service Level Agreement that will provide more timely access to data. +No, the data available via the Query API is free-of-charge. In the future, we will offer a paid-for Service Level Agreement that will provide additional features and services. ### Can the data be audited? From a0d61ada10cf0eccd491c52e29de3ebba925478c Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:11:12 +0200 Subject: [PATCH 4/9] removed update stemming from last november Removed the update that ED is running normally as the issue seemed to have been november nearly a year ago. --- docs/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index ea0572a..d227df4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,8 +2,6 @@ Version 1.0.0 - Beta -> UPDATE: **The Event Data Beta service is now functioning normally.** The Percolator stopped processing new data in November, but it is now running, processing new Events, and has re-scanned the problem period. - ## A note about Beta Crossref Event Data has not yet launched as a production service, but is currently available in Beta. This means: From 51a59d0fba7ffe9697fa4498885d060159991b36 Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:13:44 +0200 Subject: [PATCH 5/9] production ready I changed the wording in the beta section to reflect we are now production ready. removed the warning about not building customer facing tools with ED and replaced with encouragement to do so. --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index d227df4..07dc25f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,14 +4,14 @@ Version 1.0.0 - Beta ## A note about Beta -Crossref Event Data has not yet launched as a production service, but is currently available in Beta. This means: +Crossref Event Data has now launched as a production service, but is currently still in Beta. This means: - **If you have feedback or a specific use case to share, we'd love to hear from you**. You can email eventdata@crossref.org . - The Beta service is freely available, but we recommend you contact us to register as a Beta tester so we can keep you in the loop. - The Beta service isn't feature-complete and there may be functionality mentioned in this Guide that is not yet implemented. -- We cannot guarantee the stability of the Beta service. -- All data you collect from Event Data during Beta is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Until Event Data is in production mode though, we do not recommend building any commercial or customer-based tools off the data. -- You may find bugs. If you do, please contact us. +- All data you collect from Event Data during Beta is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). +- Event Data is now in production mode, this means we do not anticipate making any breaking changes to the code and you are encouraged to build customer facing tools with Event Data. +- As always, it is possible you may find bugs. If you do, please contact us. ## This guide is for everyone From de93ad12101365048793f05f26c4947efe374a47 Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:15:24 +0200 Subject: [PATCH 6/9] removed one beta mention Removed one beta mention in the intro page as I feel it is a bit redundant and overkill given we want to encourage people to really use it. --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 07dc25f..75d43e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ This Guide is a living document, and if you have questions or suggestions you ca ## Quick Start -If you're keen to get your hands on the data, you can jump straight to the [Quick Start](https://www.eventdata.crossref.org/guide/service/quickstart/) page. Please bear in mind that the service is in Beta. +If you're keen to get your hands on the data, you can jump straight to the [Quick Start](https://www.eventdata.crossref.org/guide/service/quickstart/) page. All data collected from Event Data is licensed for public sharing and reuse, according to our [Terms of Use](https://www.crossref.org/services/event-data/terms/). Every Event will include a `license` link so you know which licence applies to the data, as well as a `terms` link which points to our Terms of Use page where all the information and links you need regarding re-use will be available. Please ensure you read the [Terms of Use](https://www.crossref.org/services/event-data/terms/) before using Event Data. From 693da08b2f1a8f38a6d1420ae997368040bceb17 Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:17:38 +0200 Subject: [PATCH 7/9] updated examples dates made the example dates used 1 year ahead to make them a bit more fresh and relevant sounding. --- docs/introduction.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index bce2d0f..cc0a111 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -73,11 +73,11 @@ Crossref Event Data was developed alongside the NISO recommendations for Altmetr Crossref Event Data is available via our Query API. The Query API allows you to make requests like: - - give me all Events that were collected on 2016-12-08 - - give me all Events that occurred on 2015-12-08 - - give me all the Reddit Events that were collected on 2015-12-08 - - give me all the Events that occurred for this DOI on 2016-01-08 - - give me all the Twitter Events that occurred for this DOI on 2016-01-08 + - give me all Events that were collected on 2017-12-08 + - give me all Events that occurred on 2016-12-08 + - give me all the Reddit Events that were collected on 2016-12-08 + - give me all the Events that occurred for this DOI on 2017-01-08 + - give me all the Twitter Events that occurred for this DOI on 2017-01-08 The Query API allows you to collect Event Data in bulk, to make sure you're up to date. From 9d2382702779e257a9808813e63a012bf70e5bce Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Tue, 11 Sep 2018 11:19:23 +0200 Subject: [PATCH 8/9] SLA wording adjusted the wording to be a bit more general on the SLA --- docs/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index cc0a111..eeb5903 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -93,4 +93,4 @@ Interpretation is a significant theme in Event Data, and it's something you must *This feature will be available once Event Data is a production service* -We will introduce a Service Level Agreement which will provide agreed service levels for responsiveness of the service. It will also include APIs for access to data. +We will introduce a Service Level Agreement which will provide agreed service levels. It will also include APIs for access to data. From 5eed41690734dbb8f9f5b833d3d0710443dc3f2a Mon Sep 17 00:00:00 2001 From: Christine Buske Date: Wed, 12 Sep 2018 16:06:40 +0200 Subject: [PATCH 9/9] update to FAQ pay for data removed mention of SLA after discussion with Jennifer. we can add info on this when it is relevant. --- docs/app-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app-faq.md b/docs/app-faq.md index 5111cc6..ab0dac6 100644 --- a/docs/app-faq.md +++ b/docs/app-faq.md @@ -24,7 +24,7 @@ All APIs use JSON format ### Do I have to pay for the data? -No, the data available via the Query API is free-of-charge. In the future, we will offer a paid-for Service Level Agreement that will provide additional features and services. +No, the data available via the Query API is free-of-charge. ### Can the data be audited?