Skip to content

Commit

Permalink
CORE-4891: add services pages yml files (#296)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekachxaidze98 authored May 1, 2024
1 parent f3aab18 commit b132a8b
Show file tree
Hide file tree
Showing 60 changed files with 947 additions and 0 deletions.
17 changes: 17 additions & 0 deletions api/features.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
features:
-
title: The biggest research repository
description: |
Free real-time machine access to the world's largest collection of open access papers.
-
title: Unlimited access
description: |
Harmonised access to data from across the network of CORE providers.
-
title: Machine-readable access
description: |
Direct machine access to full texts of research papers.
-
title: Detailed documentation
description: |
Accessible and easy to understand description of using CORE API.
14 changes: 14 additions & 0 deletions api/header.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
header:
id: header
title: CORE API
icon: /images/services/api.svg
image: /images/services/server.svg
description: Develop applications, products or services based on [our vast corpus](https://core.ac.uk/data) of searchable research papers
actions:
- caption: Register now
variant: contained
url: '#form'
- caption: Download our flyer
variant: text
url: /resources/Flyer-API-Service.pdf
target: _blank
12 changes: 12 additions & 0 deletions api/how-it-works.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
how-it-works:
title: How it works
image: /images/services/work.svg
description: |
CORE collects, harmonises and enriches large quantities of both metadata and full text research articles from thousands of [data providers](/data-providers). On top of this continuously growing corpus, we provide a truly unique API providing real-time machine access to both the metadata and full texts of research papers, enabling developers to build and run innovative applications on top of CORE's content.
action:
- title: Access documentation
url: https://api.core.ac.uk/docs/v3
variant: contained
- title: see data statistics
url: /data
variant: outlined
15 changes: 15 additions & 0 deletions api/logos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
logos:
items:
- img: /images/logos/iris.png
alt: "iris"
- img: /images/logos/audemic.svg
alt: "audemic"
- img: /images/logos/interac.svg
alt: "interac"
- img: /images/logos/flowcite.svg
alt: "flow"
- img: /images/logos/cypris.svg
alt: "cypris"
action:
caption: Show all
url: '/about/endorsements'
27 changes: 27 additions & 0 deletions api/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
main:
items:
- title: Where to start?
content: |
Please [register to receive an API key](/api-keys/register)
and start testing the [live examples](https://api.core.ac.uk/docs/v3).
A good starting point to start coding with our API is to
follow the examples gallery available in the [documentation](https://api.core.ac.uk/docs/v3#section/Quick-start-examples).
In collaboration with [rOpenSci](https://ropensci.org/) you can find
an [R client for the CORE API](https://github.com/ropensci/rcoreoa) in the GitHub repository.
All our SDKs are available from [our GitHub organisation](https://github.com/oacore).
- title: Can I use the CORE API for commercial purposes?
content: |
Yes, you can use the CORE API for commercial purposes,
[(Terms & Conditions)](https://core.ac.uk/terms) apply.
We provide 30 Day Free Trial for Institution and Enterprise.
We will ask you for your circumstances during the registration process
and we might contact you afterwards to clarify any points and assess your eligibility
for a free licence. If your circumstances change, you need to let us know about it.
- title: Rate limits
content: |
CORE API is free and does not require registration, subject to our [rate limits](https://api.core.ac.uk/docs/v3#section/Rate-limits). However, organisations that register get a faster rate that is typically not free. For [Supporting and Sustaining Members](/membership), the faster rate comes as a free member benefit.
note: If you use CORE in your work, we kindly request you to cite one of our publications.
action:
title: cite publication
url: https://core.ac.uk/about/research-outputs
3 changes: 3 additions & 0 deletions api/meta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
id: api
title: CORE API
tagline: Develop new applications with the CORE API
11 changes: 11 additions & 0 deletions api/more-about-us.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
institutionBenefit:
title: Find out how other institutions [benefited](documentation/membership-documentation) from CORE API
item:
- title: How the Oxford University Research Archive (ORA) uses the CORE API
description: CORE harvests and aggregates information of research papers collected from institutional and subject repositories, and open access and hybrid journals, and makes the content available via an API. The CORE API offers a wealth of metadata and full text content from its many data providers. For ORA (Oxford University Research Archive), the use of the CORE API offers an opportunity to enhance workflows and streamline the process of reviewing and curating articles for inclusion in the repository...
user: Jason Partridge
position: Open Access Service Manager at the Bodleian Libraries, University of Oxford.
img: /images/ora.svg
action:
title: read more
url: https://blog.core.ac.uk/2024/03/05/how-the-oxford-university-research-archive-ora-uses-the-core-api/
6 changes: 6 additions & 0 deletions api/register.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
form:
title: Register for an API key
subtitle: Enter your email address to register for a new API key, or restore a previous API key. If you are registering in an institutional capacity, please enter your institutional email.
helper: We will send the key and instructions to this address
action: Register now
note: Check our [Terms & Conditions](https://core.ac.uk/terms) to see if you are elegible for a free license.
19 changes: 19 additions & 0 deletions api/related-services.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
related-services:
title: You might be also interested in
services:
-
title: CORE Dataset
picture: /images/services/dataset.svg
url: dataset
-
title: CORE FastSync
picture: /images/services/fastsync.svg
url: fastsync
-
title: CORE Recommender
picture: /images/services/recommender.svg
url: recommender
-
title: CORE Discovery
picture: /images/services/discovery.svg
url: discovery
18 changes: 18 additions & 0 deletions api/stats.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
stats:
items:
- title: more than
count: "{{fullTextCount}}"
caption: full texts
- title: more than
count: "{{totalArticlesCount}}"
caption: searchable research papers
- title: more than
count: "{{repositoriesCount}}"
caption: data providers
- title: more than
count: "150"
caption: countries
action:
title: see data statistics
url: /data
variant: outlined
13 changes: 13 additions & 0 deletions api/testimonials.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
testimonials:
-
id: Botev
content: |
“We are integrating the CORE API into our product, IRIS, because so far it is the open access portal that covers almost all open access content, provides easy to integrate API and has a powerful search querying engine. We want to make open access articles more easily accessible and more useful to researchers and the open public and we see the CORE API as a way to speed that up.”
author:
name: Viktor Botev
role: CTO, Iris AI AS
picture: /images/people/botev.jpg
action:
title: SEE More testimonials
url: /about/endorsements#partner-projects
variant: outlined
16 changes: 16 additions & 0 deletions api/what-is-included.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
what-is-included:
title: What’s included
content: |
The API provides you with:
* Real-time machine access to the world's largest corpus of open access research papers, containing both metadata and full texts.
* Harmonised access to data accross CORE’s provider network
* Detailed [documentation](https://api.core.ac.uk/docs/v3) on how to use the CORE API with live examples and wrappers to common programming languages.
* One batch request or five single requests per 10 seconds. Need a faster rate? [Contact us](/about#contact).
* Scalable [API rates:](https://api.core.ac.uk/docs/v3#section/Rate-limits)
1. Free API access without registration (subject to our T&Cs)
2. Better performance for registered users
3. Need an even faster rate? Contact us for a VIP rate quote.
If you use CORE in your work, we kindly request you to [cite one of our publications.](/about/research-outputs)
image: /images/services/delivery.svg
16 changes: 16 additions & 0 deletions dashboard/additional.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
additional:
title: Register for the CORE Dashboard
image: /images/screenshots/charts-placeholder.png
content: |
The Repository Dashboard has been created in an effort to improve
the quality and transparency of the harvesting process of open access
content and to create a two way collaboration between the CORE
project and our data providers.
actions:
- caption: BECOME A MEMBER TO GET ACCESS
url: /membership
hint: For those who are not CORE Data Providers
primary: true
- caption: LOG IN
hint: For those who are CORE Data Providers
url: https://dashboard.core.ac.uk/login
17 changes: 17 additions & 0 deletions dashboard/features.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
features:
-
title: Managing content
description: |
Monitor repository indexing and health. Manage access to documents from your repository in CORE and see your download stats.
-
title: Register your OAI identifiers
description: |
Freely register your OAI identifiers so that our OAI Resolver can resolve these PIDs directly and persistently to your repository system.
-
title: Content enrichments
description: |
Obtain DOI enrichments detected by CORE for your content.
-
title: Compliance checking
description: |
Assess how your repository meets open access policies and best practices.
21 changes: 21 additions & 0 deletions dashboard/header.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
header:
id: header
title: CORE Dashboard
icon: /images/services/repository-dashboard.svg
image: /images/services/dashboard-charts.svg
description: |
The Repository Dashboard is a service provided to CORE Members.
It offers a range of tools for repository management,
content enrichment, metadata quality assessment and open access
compliance checking. It serves as a central hub for accessing
member services for data providers, such as to configure
CORE’s [OAI Resolver](https://core.ac.uk/documentation/oai-resolver), Recommender and Discovery services
for your repository or to promote your organisation to millions
of CORE’s users.
actions:
- caption: BECOME A MEMBER TO GET ACCESS
variant: contained
url: /membership
- caption: Log in
variant: outlined
url: https://dashboard.core.ac.uk/login
22 changes: 22 additions & 0 deletions dashboard/how-it-works.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
how-it-works:
title: How it works
image: /images/services/work.svg
description: |
The Repository Dashboard provides an online interface offering
valuable technical information and statistics for content providers.
It is the tool you need to check that your repository is
configured correctly to provide maximum visibility to your research
outputs. Additional features include OAI Resolver resolution,
persistent identifiers (PIDs) enrichments, access to repository tools
enhancing user experience (Recommender and Discovery) and ability to
promote your logos across the CORE ecosystem. For UK members,
it also offers REF Open Access compliance monitoring and a RIOXX
metadata quality validator.
action:
- title: Log in
variant: outlined
url: https://dashboard.core.ac.uk/login
- title: dashboard presentation
url: /resources/CORE-Dashboard-tool-for-the-management-of-open-access-content.pdf
variant: contained
target: _blank
38 changes: 38 additions & 0 deletions dashboard/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
main:
items:
- title: Institutions using the Repository Dashboard
content: |
Here are some of the insitutions using the CORE Repository Dashboard
around the world.
**Australia**
- University of Adelaide
- University of Canberra
**Belgium**
- University of Liège
- University of Louvain
**Netherlands**
- Utrecth University
- TU Delft University
**South Africa**
- University of Cape Town
**United Kingdom**
- Cambridge University
- University of Leeds
- University of Sheffield
- University of York
- London School of Economics
- Imperial College London
- Strathclyde University
**United States**
- Columbia University
- Harvard University
note: If you use CORE in your work, we kindly request you to cite one of our publications.
action:
title: cite publication
url: https://core.ac.uk/about/research-outputs
3 changes: 3 additions & 0 deletions dashboard/meta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
id: repository-dashboard
title: CORE Dashboard
tagline: Manage your repository outputs and ensure they are visible to the world
19 changes: 19 additions & 0 deletions dashboard/related-services.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
related-services:
title: You might be also interested in
services:
-
title: CORE Discovery
picture: /images/services/discovery.svg
url: discovery
-
title: CORE Search
picture: /images/services/search.svg
url: /
-
title: CORE Recommeneder
picture: /images/services/recommender.svg
url: recommender
-
title: CORE API
picture: /images/services/api.svg
url: api
13 changes: 13 additions & 0 deletions dashboard/testimonials.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
testimonials:
-
id: Botev
content: |
“The [CORE Repository Dashboard](https://core.ac.uk/services/repository-dashboard) provides an excellent level of
feedback and control over what gets harvested, aggregated and exposed.
It also provides intelligence on harvesting errors which may need
troubleshooting, thereby ensuring optimum repository health for text mining
as well as discovery of repository content.”
author:
name: George Macgregor
role: Institutional Repository Manager, University of Strathclyde
picture: /images/people/macgregor.png
52 changes: 52 additions & 0 deletions dashboard/tutorials.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
materials:
title: Dashboard features overview
cards:
- image: /images/membership/videoPreview.svg
key: access
title: How to access the CORE dashboard
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/nxAbFFSqddQ
- image: /images/membership/videoPreview.svg
key: duplicates
title: Checking duplicates in your repository
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/56KqdNtq_1A
- image: /images/membership/videoPreview.svg
key: oa
title: Using CORE to check OA compliance
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/X-A64CoTtcE
- image: /images/membership/videoPreview.svg
key: notifications
title: Setting up notifications
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/Ezgckn-4B1Q
- image: /images/membership/videoPreview.svg
key: logo
title: Using CORE to check your repository
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/YyZ_MXLKcRs
- image: /images/membership/videoPreview.svg
key: ror
title: Setting your repository in the Dashboard - ROR ID set up
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/aT1CORAmv-0
- image: /images/membership/videoPreview.svg
key: repository
title: How to upload your logo to articles appearing in CORE
action:
caption: Watch video
video:
src: https://www.youtube.com/embed/qcQP3ZWMP30
Loading

0 comments on commit b132a8b

Please sign in to comment.