Skip to content
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

Simplify README a bit to more strongly recommend a default usage #29

Merged
merged 1 commit into from
May 29, 2020

Conversation

RickMoynihan
Copy link
Member

Some improvements to the README.

Mainly just orientating it around using deps.edn as the prefered way of building and including validation suites, and moving finer details of other approaches that people wanting to get started don't need to know immediately into supporting documents in the docs folder.

@jennet
Copy link

jennet commented May 28, 2020

This is really nicely written 👍 @RickMoynihan

At this point

You'll then want to configure some validation suites and supply it with the location of some RDF (either via a SPARQL endpoint) or as a file of triples.

It might be useful to have an example of simply running the rdf-validator against an endpoint with a single sparql query file (i.e. expand slightly on the $ clojure -A:rdf-validator <ARGS>) before jumping in to defining/including suites.

@RickMoynihan
Copy link
Member Author

RickMoynihan commented May 28, 2020

Agreed that would be useful, though better yet I think would be for our example validations to be designed to run against a public site, e.g. scotland's SPARQL endpoint.

The example validation suite could include a single passing and a single failing validation for example e.g.

  • ✅ Every dataset on scotland has a label
  • ⚠️ Every qb:Dataset defines a :gender dimension (or some other validation that should purposefully always fail).

That way users could run the example immediately, then tweak to their data/endpoint.

@RickMoynihan
Copy link
Member Author

We could maybe do this as another PR?

@jennet
Copy link

jennet commented May 28, 2020

Added issue for the examples enhancement to the README #30

Copy link

@jennet jennet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to go with this restructuring and rewrite

@RickMoynihan RickMoynihan merged commit a53d4e0 into master May 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants