Skip to content

Commit

Permalink
Add some background information
Browse files Browse the repository at this point in the history
  • Loading branch information
@ldodds
ldodds committed Feb 23, 2018
1 parent f94193c commit fea17d1
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 27 deletions.
2 changes: 1 addition & 1 deletion public/js/oa-api-dashboard.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
$(function() {

$("table").tablesorter({
$("#datasets-table").tablesorter({
theme : "bootstrap",
sortList: [[0,0]],
widthFixed: true,
Expand Down
126 changes: 102 additions & 24 deletions views/about.erb
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,115 @@
<br/><br/>
<section class="container">

<h1>About</h1>

<p>The OpenActive API dashboard provides publishers and users with a tool to find and understand OpenActive data published by various providers.</p>
<h1>About the opportunity data dashboard</h1>

<p>
<a href="https://www.openactive.io/">OpenActive</a> is a community-led initiative using open data to help people get active.
The opportunity data dashboard lists all of the openly licensed datasets and APIs published as part of the OpenActive initiative.
</p>
<p>
Opportunity data is about where and when sport and physical activities happen. For example, when and where
a yoga class or group run is taking place.
</p>
<p>
Using the opportunity data feeds, you can harvest data about sporting and physical activities from across the UK.
This data is made available for anyone to access, use, and share under an open licence. You are free to use the data
to help build new products and services, for example to help people discover opportunities to be more phyiscally
active.
</p>
<p>
The dashboard provides an overview of which datasets are available, which data publishers
support <a href="https://www.w3.org/community/openactive/">the OpenActive standards</a> and
short summaries of the standardised data.
</p>

<br/>
<h2>Dashboard columns</h2>
<h2>Dashboard overview</h2>

<p>On the homepage you can find a table showing the various features of the each provider's API. Above the table you'll find a date and time which show how recently the datasets were updated. The dashboard should update every 30 minutes.</p>

<p>Columns, with explanations are as follows:</p>

<h4>Provider</h4>
<p>States the provider name and a link to the dataset information page.</p>

<h4>Endpoint</h4>
<p>Provides a link to the API endpoint and shows whether the endpoint is responding to requests.</p>

<h4>Uses paging spec?</h4>
<p>Indicates whether the dataset conforms to the <a href="https://www.openactive.io/realtime-paged-data-exchange/">Realtime Paged Data Exchange specification</a>.</p>

<h4>Uses opportunity model?</h4>
<p>Indicates whether the dataset conforms to the <a href="https://www.openactive.io/modelling-opportunity-data/">Opportunity Model specification</a>.</p>

<h4>Includes coordinates?</h4>
<p>Indicates whether any latitude longitude coordinates were found for any of the items in the dataset.</p>

<h4>Issues</h4>
<p>Displays the number of Github issues relevant to the dataset. This also links to the datasets github issues page, where you can discuss problems or contribute suggestions about the dataset.</p>

<h4>Licence</h4>
<p>Shows and links to the licence which applies to the dataset.</p>
<table class="table">
<thead>
<tr><th>Column name</th><th>Description</th></tr>
</thead>
<tbody>
<tr>
<td>
Provider
</td>
<td>
States the provider name and a link to the dataset information page.
</td>
</tr>

<tr>
<td>
Endpoint
</td>
<td>
Provides a link to the API endpoint and shows whether the endpoint is responding to requests.
</td>
</tr>

<tr>
<td>
Uses paging spec?
</td>
<td>
Indicates whether the dataset conforms to the <a href="https://www.openactive.io/realtime-paged-data-exchange/">Realtime Paged Data Exchange specification</a>
</td>
</tr>

<tr>
<td>
Uses opportunity model?
</td>
<td>
Indicates whether the dataset conforms to the <a href="https://www.openactive.io/modelling-opportunity-data/">Opportunity Model specification</a>
</td>
</tr>

<tr>
<td>
Includes coordinates?
</td>
<td>
Indicates whether any latitude longitude coordinates were found for any of the items in the dataset.
</td>
</tr>

<tr>
<td>
Issues
</td>
<td>
Displays the number of Github issues relevant to the dataset. This also links to the datasets github issues page, where you can discuss problems or contribute suggestions about the dataset
</td>
</tr>

<tr>
<td>
Summary
</td>
<td>
Summaries are available for those datasets that conform to the standard data model. The summary includes
a list of activities frequently found in the list, as well as a geographical breakdown for those feeds
that include co-ordinates.
</td>
</tr>
<tr>
<td>
Licence
</td>
<td>
Shows and links to the licence which applies to the dataset.
</td>
</tr>

</tbody>
</table>

<h2>Dataset Summaries</h2>
<p>If a dataset conforms to the two specifications above the dashboard will produce a summary.</p>
Expand Down
12 changes: 10 additions & 2 deletions views/index.erb
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
<header class="jumbotron">
<div class="container">
<h1 class="">OpenActive API Dashboard</h1>
<p>A dashboard to support OpenActive API users &amp; publishers.</p>
<h1 class="">OpenActive Opportunity Data Dashboard</h1>
<p>
This dashboard lists all of the datasets and APIs published as part of the OpenActive initiative.
From these feeds, you can harvest data about sporting and physical activities from across the UK.
<a href="/about">Read more about opportunity data</a>.
</p>
<p>
Using this dashboard you can see which data publishers support <a href="https://www.w3.org/community/openactive/">the OpenActive
standards</a> and explore summaries of the standardised data.
</p>
</div>
</header>

Expand Down

0 comments on commit fea17d1

Please sign in to comment.