How to add an Invenio installation to the showcase

Follow four easy steps to make a pull request

1
Fork our source code

Fork inveniosoftware.org source code repository using your GitHub account (e.g. johndoe) and create a new local branch (e.g. johndoelibrary):

$ git clone https://github.com/johndoe/inveniosoftware.org $ cd inveniosoftware.org $ git checkout -b johndoelibrary

2
Take a beautiful screenshot

Take a representative screenshot of your site and place it in the src/assets/images/showcase directory. Name the image after your site.

# take screenshot $ mv ~/Screenshots/johndoelibrary.png src/assets/images/showcase/

3
Describe your site

Add a JSON description of your site, such as its full name, the description, the canonical URL, the country, and the screenshot filename, inside the file src/_data/showcase.json in right section between rdm (for InvenioRDM), ils (for InvenioILS), framework_v3 (for Invenio v3 Framework) or v1 (for Invenio v1).

{ "name": "John Doe Library", "description": "John Doe's Library.", "country": "CH", "url": "https://example.org/johndoelibrary", "screenshot": "johndoelibrary.png" }

4
Make a pull request

Commit your changes and publish your branch.

$ git add src/assets/images/showcase/johndoelibrary.png $ git src/_data/showcase.json $ git commit -s -m "sites: John Doe Library" $ git push origin johndoelibrary

Make a pull request so that we can add your site.