Giter VIP home page Giter VIP logo

event-data-user-guide's Introduction

Event Data User Guide

The guide is available to read at at http://www.eventdata.crossref.org/guide

To build:

mkdocs build

To upload:

aws s3 sync site s3://event-data-www/guide/

Note that site uses cloudfront so there will be a delay while edge caches update. To force an emmediate update invalidate the objects you want to update in the cloudfront distribution.

License

Copyright © Crossref

Distributed under the The MIT License (MIT).

event-data-user-guide's People

Contributors

afandian avatar chrissiecw avatar gbilder avatar jamesbloomer avatar jenniferlin15 avatar mwats0n avatar nvander1 avatar several27 avatar vinnl avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

event-data-user-guide's Issues

Create Realtion Types chart

Please list out the Works and Relation Types for each source for MVP and send to Maddy. Can I please have this by the end of tomorrow (Friday 8th)?

This is the epic

Owner

TODO

Description

  • For TODO
  • Who TODO
  • The TODO
  • Is a TODO
  • That TODO
  • Unlike TODO
  • This solution TODO

Business Outcomes

  • TODO

Leading Indicators

  • TODO

Nonfunctional Requirements

  • TODO

Related Features

  • TODO LINK TO INDIVIDUAL MILESTONES

URL reversal accuracy

Can URL -> DOI links be guaranteed accurate?

  • no, rely on metadata in pages and other algorithms, have to trust that
  • however we whitelist the domains we look at
  • you can look at the source

Describe deprecated flag

Or should it be 'retracted'? When we review an Event and decide it shouldn't have happened.

  • When is it set?
  • Under what circumstances?
  • What to do
  • When is it in the API?

Write push source documentation for Mendeley

After MVP, we will be providing Mendeley with documentation on our push source to help inform their own push source development. Please let me know when this is ready so that I can forward it on to Sebastian & co.

timezone

mention timezone is UTC somewhere. also check that this is true.

Quickstart prefix filter example is wrong

Example given:

curl "https://query.eventdata.crossref.org/events?rows=10000&filter=source:reddit,prefix:10.1371"

Should probably be:

curl "https://query.eventdata.crossref.org/events?rows=10000&filter=source:reddit,obj-id.prefix:10.1371"

FAQ items

  • What does the percolator do?
  • The “obj” element in a query quotes both the url and the PID, but they’re always the same. What’s the difference?
  • Where does the licence element get its data from? Is it the licence of the website mentioning the content, or the content itself?

Data notifications

Describe (or stub) API for checking notifications e.g. compliance, deprecated flag.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.