Data on software, projects, people, organizations, publications and reports in eStep.
_software/
, _person/
, _project/
, _publication/
, _report/
and _organization/
directories.Install the estep website utility by running
pyvenv .env3
. .env3/bin/activate
pip install -U pip wheel
pip install -r requirements.txt -e .
Clone this repo
Create a branch for your additions with the gh-pages branch as a starting point.
In _software
directory, add a Markdown file with front matter (https://jekyllrb.com/docs/frontmatter/) for your software.
schema/
directory..md
and contain no url-unfriendly characters (e.g. space, /)._software/
, _person/
, _project/
, _publication/
, _report/
and _organization/
directories, e.g. some software is used in a project then write a Markdown file in both the _software
and _project
directories. If someone else is responsible for the data in related pages, place a stub there with at least the correct name
. If it concerns a person, also fill in affiliation
.user
property, also update that users' userOf
property. Other examples of reciprocal relations: organization#involvedIn
vs project#involvedOrganization
, software#user
vs organization#uses
, software#engineer
vs person#engineerOf
.http://software.esciencecenter.nl
can be omitted. HTTPS is not supported on this site.Many relations are reciprocal, be sure to fill them in for both related objects. For example, when updating software's user
property, also update that users' userOf
property. Other examples of reciprocal relations: organization#involvedIn
vs project#involvedOrganization
, software#user
vs organization#uses
, software#engineer
vs person#engineerOf
. Automatically fill them in with
estep generate reciprocal
Download remote logos (if any) with
estep generate logo
After editing data, test the validity of the entered data with
estep validate -v
Commit and push changes.
Create a pull request to merge your changes into the gh-pages branch.
Publications are stored in the _publication/
directory.
A publication Markdown file can be generated with it's DOI by running:
estep generate publication http://dx.doi.org/10.1002/cpe.3416
A publication can be linked to a project by using the --project=<project_url>
argument.
The website uses Jekyll powered Github pages.
To preview locally use docker:
docker run --rm --volume=$(pwd):/srv/jekyll -i -t -p 127.0.0.1:4000:4000 jekyll/jekyll:pages jekyll serve
The website can be viewed on http://localhost:4000
The docker container will fail when there is a virtualenv in the current working directory. Resolve by putting virtualenv somewhere else or prefixing it with '.'.
To preview without Docker:
gem install jekyll
gem install github-pages
jekyll serve -w