Skip to content

Commit

Permalink
Merge pull request #63 from supernord/edits
Browse files Browse the repository at this point in the history
Edits for "about" and "project" sections
  • Loading branch information
supernord authored Nov 11, 2024
2 parents f0980b9 + 2c985c8 commit ec22a49
Show file tree
Hide file tree
Showing 16 changed files with 179 additions and 140 deletions.
24 changes: 23 additions & 1 deletion _data/CONTRIBUTORS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,26 @@
Bert Droesbeke:
git: bedroesb
email: [email protected]
orcid: 0000-0003-0522-5674
orcid: 0000-0003-0522-5674

Johan Gustafsson:
git: supernord
orcid: 0000-0002-2977-5032
role: product owner
affiliation: Australian BioCommons / University of Melbourne

Frederik Coppens:
git: frederikcoppens
role: product owner
affiliation: VIB

Carole Goble:
git: CaroleGoble
orcid: 0000-0003-1219-2137
role: product owner
affiliation: University of Manchester

Finn Bacall:
git: fbacall
role: lead developer
affiliation: University of Manchester
8 changes: 2 additions & 6 deletions _data/footer.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
extra_line: |
![Flag of the European Union](/assets/img/eu-flag-small.png)
[EOSC-Life](https://www.eosc-life.eu/) is funded by European Union’s Horizon 2020 programme under
grant agreement number [824087](https://doi.org/10.3030/824087) and [additional funding](/project/acknowledgements/#funding).
copyright: |
[about.workflowhub.eu](https://about.workflowhub.eu/) content is distributed under
[BSD 3-Clause "New" or "Revised" License](https://github.com/workflowhub-eu/about/blob/master/LICENSE),
Expand All @@ -10,8 +6,8 @@ columns:
- type: image
image_width: 120px
width: 3
src: '/assets/img/eosc-life.svg'
alt: EOSC-Life
src: '/assets/img/workflowhub-square.svg'
alt: workflowhub logo square
- type: links
width: 3
children:
Expand Down
12 changes: 12 additions & 0 deletions _data/tiles.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
- title: "Production instance"
url: https://workflowhub.eu/
- title: "Sandbox instance"
url: https://dev.workflowhub.eu/
- title: "Source code"
url: https://github.com/seek4science/seek
- title: "Documentation"
url: docs/
- title: "Outreach and Publications"
url: project/outreach
- title: "Roadmap"
url: project/roadmap
4 changes: 1 addition & 3 deletions _data/topnav.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
## Topnav single links
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
subitems:
- title: Home
url: /
- title: About
url: /project/
url: /
- title: Documentation
url: /docs/
2 changes: 0 additions & 2 deletions _includes/citation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@ Ove Johan Ragnar Gustafsson, Sean R. Wilkinson, Finn Bacall, Stian Soiland-Reyes
_arXiv_:2410.06941 [cs.DL]
<https://doi.org/10.48550/arXiv.2410.06941>


See also [publication and outreach](/project/outreach) for more specific work.
9 changes: 9 additions & 0 deletions _includes/tiles-simple.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div class="row row-cols-1 row-cols-md-2 row-cols-lg-{{ include.col | default: 2 }} gy-2 gx-4 my-4 navigation-tiles">
{%- for item in site.data.tiles %}
{%- if item.title %}
<div class="col d-grid">
<a role="button" class="btn btn-secondary text-light font-size-sm py-4 fs-3" href="{{ item.url | relative_url }}">{{item.title}}</a>
</div>
{%- endif %}
{%- endfor %}
</div>
13 changes: 8 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
---
title: Quick start guide
title: Documentation
toc: false
page_id: docs
redirect_from:
- /docs/before-you-start/
- /docs/onboarding/
- /docs/getting-started/
---


## Quick start guide

**WorkflowHub will help make your workflows findable and citable, and this guide will help you get started with that process.**

{% include callout.html type="tip" content="if you want to test WorkflowHub and its features, there is a [development instance available here](https://dev.workflowhub.eu/)." %}

## 1. Register yourself on WorkflowHub
### 1. Register yourself on WorkflowHub

Register yourself on the [sign up page](https://workflowhub.eu/signup) of WorkflowHub if you do not have an account. You can also log in using your [LS Login](https://lifescience-ri.eu/ls-login/) or [GitHub](https://github.com/) credentials.


## 2. Decide which `Space` you would like to create a `Team` in
### 2. Decide which `Space` you would like to create a `Team` in

**Figure 1** below highlights the basic structure of WorkflowHub, and examples of the three types of `Spaces` where you could create a `Team`. Learn more about `Teams` and `Spaces` [here](/docs/space-team-organisation).

Expand All @@ -36,7 +39,7 @@ You can request to create a `Team` in any or all of the following `Spaces`:
{% include callout.html type="note" content="you can create multiple teams in multiple spaces, depending on your requirements." %}


## 3. Create a team or join an existing team
### 3. Create a team or join an existing team

Go to the [create](https://workflowhub.eu/projects/guided_create) and [join](https://workflowhub.eu/projects/guided_join) a team page from WorkflowHub to do so.

Expand All @@ -56,7 +59,7 @@ More information on how to join a team can be found on the [how to create and jo
{% include image.html file="team.svg" caption="Fig 2. Screenshot of required minimum information (numbered) that needs to be entered into the *Create a New Team* wizard on WorkflowHub." alt="minimum information" %}


## 4. Register workflow(s)
### 4. Register workflow(s)

Workflows can be registered using the [WorkflowHub wizard](https://workflowhub.eu/workflows/new)

Expand Down
135 changes: 97 additions & 38 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,122 @@
---
title: WorkflowHub project
toc: false
toc: true
permalink: /
# There are special sidebar rules for the index page in layouts/default.html
hide_sidebar: true
sidebar: true
---

[WorkflowHub](https://workflowhub.eu/) is a FAIR **workflow registry** sponsored by the European RI Cluster EOSC-Life, the European Research Infrastructure ELIXIR and [multiple EU-wide projects](/project/acknowledgements/#funding). It is workflow management system agnostic: workflows may remain in their native repositories in their native forms.
## About

This website describes the open source **project** for developing and running [WorkflowHub](https://workflowhub.eu/).
This website describes the open source project for developing and running [**WorkflowHub**](https://workflowhub.eu/): a FAIR registry for describing, sharing and publishing scientific computational workflows. The registry is sponsored by the European RI Cluster EOSC-Life, the European Research Infrastructure ELIXIR, and [multiple EU-wide projects](/project/acknowledgements/#funding).

For more details, see [About WorkflowHub](/project), [FAIR Computational Workflows](https://workflows.community/groups/fair/), [Outreach and Publications](/project/outreach).
[WorkflowHub](https://workflowhub.eu):

For any kind of questions or suggestions on using WorkflowHub, feel free to join our [community](/project/community)!
* Is a **domain-agnostic** workflow registry designed around [FAIR principles](https://workflows.community/groups/fair/).
* Is **workflow management system agnostic**: workflows may remain in their native repositories in their native forms.
* Provides features such as community spaces, collections, versioning and snapshots, and contributor credit.
* Allows workflows to be FAIR, citable, have managed metadata profiles, and be openly available for review and analytics.

## Documentation
In addition:

* Workflows are packaged, registered, downloaded and exchanged as [workflow-centric Research Objects](/Workflow-RO-Crate/) using the [RO-Crate](https://w3id.org/ro/crate) specification, with test and example data, managed metadata profiles, citations and more.
* A [schema.org](https://schema.org/) based Bioschemas profile describes the metadata about a workflow and use of the [Common Workflow Language](https://www.commonwl.org/) is encouraged, providing a canonical description of the workflow itself.
* Popular workflow management systems such as [Galaxy](https://galaxyproject.org/), [Nextflow](https://nextflow.io/), and [Snakemake](https://snakemake.readthedocs.io/) are working with the Hub to seamlessly and automatically support object packaging, registration and exchange.
* In addition to its own [APIs](https://workflowhub.eu/api), WorkflowHub supports community registry standards and services such as [GA4GH TRS](https://about.workflowhub.eu/TRS/) and [ELIXIR-AAI](https://elixir-europe.org/services/compute/aai) authentication, and current work integrates with the [LifeMonitor workflow testing](https://lifemonitor.eu/) service.
* WorkflowHub is mainly sponsored by the European RI Cluster [EOSC-Life](https://www.eosc-life.eu/), the European Research Infrastructure [ELIXIR](https://elixir-europe.org/) and [EuroScienceGateway](http://eurosciencegateway.eu/) (see [full list of acknowledgements](/project/acknowledgements/#funding)).
* The [WorkflowHub Club](/project/community/) open community works together to continuously co-develop the Hub.

For more details, see [FAIR Computational Workflows](https://workflows.community/groups/fair/), [Outreach and Publications](project/outreach).

For any kind of questions, or suggestions on using WorkflowHub, feel free to join our [community](#community)!


## Did you know?

* The first beta-release was in Sept 2020,
* Production-release was in September 2022,
* The WorkflowHub now holds over [700 workflows](https://workflowhub.eu/workflows), including 49 curated [COVID-19 workflows](https://covid19.workflowhub.eu/),
* It is a listed resource of the European [COVID19 Data Portal](https://www.covid19dataportal.org/), and is a [EOSC Data Source](https://marketplace.eosc-portal.eu/datasources/eosc.elixir-uk.5126ffcc8e23f65bbbe219d36128f2c8).


## Citation

{% include citation.md %}

{% include callout.html type="tip" content="See also [publication and outreach](/project/outreach) for more specific work." %}

* [Documentation & Quick Start guide](docs/) (See also _Detailed Documentation_)
* [Guide to using WorkflowHub](docs/guide-to-using-workflowhub/)
* [Developer docs](developer/)
* Tutorial vidoes:
- [Make your workflows findable and citable](https://www.youtube.com/watch?v=2kGKxaPuQN8) ([slides](https://doi.org/10.5281/zenodo.7787488))
- [WorkflowHub ask-me-anything](https://workflowhub.eu/presentations/19?version=1) tutorial session

## Project resources

* **Production instance**: <https://workflowhub.eu/>
* **Sandbox instance**: <https://dev.workflowhub.eu/> (use for testing; occasionally wiped)
* **Source code**: [seek4science/seek](https://github.com/seek4science/seek)
* **API documentation**: <https://workflowhub.eu/api>
* **[Outreach and Publications](/project/outreach/)**
* **EOSC-Life Deliverable 2.3**: <https://doi.org/10.5281/zenodo.7886545>
* **Tasks**:
* [WorkflowHub roadmap](/project/roadmap) (deprecated -- now managed in Trello)
* WorkflowHub implementation <https://github.com/seek4science/seek/projects/3> (SEEK)
* General WorkflowHub <https://github.com/workflowhub-eu/about/issues>
{% include tiles-simple.html col = "2" %}

* **Tutorial videos:**
* [Make your workflows findable and citable](https://www.youtube.com/watch?v=2kGKxaPuQN8) ([slides](https://doi.org/10.5281/zenodo.7787488))
* [WorkflowHub ask-me-anything](https://workflowhub.eu/presentations/19?version=1) tutorial session


## Get involved


### Community

While WorkflowHub is largely developed as a collaboration between [several projects](/project/acknowledgements), any contributors are welcome to join our **open community**.

Anyone can [join the WorkflowHub club](https://github.com/workflowhub-eu/about/issues/1)! Either sign up on GitHub [issue #1](https://github.com/workflowhub-eu/about/issues/1) or join the [next bi-weekly Zoom call](https://s.apache.org/workflowhub-minutes) and introduce yourself.

* **When:** Alternate Wednesdays 10:00 current UK time zone / 11:00 current Central European time zone
* **Agenda, telcon details and minutes:** <https://s.apache.org/workflowhub-minutes>

See the list of WorkflowHub Club members on the [acknowledgements page](/project/acknowledgements).

For asynchronous communication, see also:

* **Mailing list**: [`workflowhub😊elixir-europe.org`](https://lists.elixir-europe.org/mailman/listinfo/workflowhub_elixir-europe.org) ([subscribe](https://lists.elixir-europe.org/mailman/listinfo/workflowhub_elixir-europe.org)/[archive](https://mail.elixir-europe.org/pipermail/workflowhub_elixir-europe.org/))
* **Slack chat**: [#workflows on seek4science.slack.com](https://seek4science.slack.com/archives/CPLLVV94L) ([join](https://join.slack.com/t/seek4science/shared_invite/zt-csqh94qb-kf~kFbZxuHl1Hpxhbc8avw))
* [Google Drive](https://drive.google.com/drive/folders/1_bZ63W4oRtWL5OnWJNYvE4u3A27VyGGe)
(to request write-access, ask in Slack channel)
* **Slides/posters** (for complete list, see [Outreach](/project/outreach/)):
* [WorkflowHub: FAIR Workflow Registry](https://doi.org/10.5281/zenodo.7323471). Justin Clark-Casey et al, EOSC Symposium 2022, 2022-11-14
* [WorkflowHub – a FAIR registry for workflows](https://doi.org/10.7490/f1000research.1118984.1). Carole Goble, ELIXIR All Hands 2022
* [WorkflowHub - a registry for workflows](https://doi.org/10.5281/zenodo.4012124). Carole Goble, ECCB 2020, 2020-09-02
* [Poster: The WorkflowHub, a registry for Life Science Workflows](https://workflowhub.eu/presentations/1). Ambarish Kumar, ISMB, 2020-07-13
* [WorkflowHub Introduction slides](https://drive.google.com/open?id=1hfBAjjRnL9jGoxHEvq66Wo-wuKqouR3C). Carole Goble, 2020-03-25
* [Google Drive](https://drive.google.com/drive/folders/1_bZ63W4oRtWL5OnWJNYvE4u3A27VyGGe): to request write-access, ask in Slack channel

## Community

Regular meeting: **WorkflowHub Club** - all welcome!
### Development

Anyone is welcome to join the bi-weekly [WorkflowHub Club](/project/community) calls using Zoom.
Created as part of the [EOSC-Life](https://www.eosc-life.eu) WP2 [Tools Collaboratory](https://github.com/eosc-life/tools-collaboratory-roadmap), WorkflowHub is in production but still under active development. See the [roadmap page](/project/roadmap) for a list of in-flight and future development activities.

* When: Alternate Wednesdays 10:00 current UK time zone / 11:00 current Central European time zone
* Agenda, telcon details and minutes: <https://s.apache.org/workflowhub-minutes>
You can also see a complete list of contributors on the [acknowledgements](/project/acknowledgements) page.



### Contact Us

The production instance <https://workflowhub.eu/> is hosted by [eScience Lab](https://esciencelab.org.uk/) at [The University of Manchester](https://www.manchester.ac.uk/) led by professor [Carole Goble](https://research.manchester.ac.uk/en/persons/carole.goble).

* [Provide feedback or ask questions](https://workflowhub.eu/home/feedback)
* [Contribute to WorkflowHub club](#community)
* [Report an issue](https://workflowhub.eu/home/report_issue) (public GitHub), or:
- Contact `workflowhub.eu` system administrators: <[email protected]>
- Report [Code of Conduct](https://github.com/workflowhub-eu/about/blob/master/CODE_OF_CONDUCT.md) concerns: <[email protected]>
* Academic collaborations: <[email protected]>


## WfCommons and WorkflowHub

Note that the US-based [WfCommons](https://wfcommons.org/), a Python-based framework for enabling scientific workflow research and development, was previously [called "WorkflowHub"](https://doi.org/10.1109/WORKS51914.2020.00012). While that framework is not related to our registry workflowhub.eu, this name collision could cause some confusion, so in common agreement with Rafael Ferreira da Silva, their former domain name `workflowhub.org`
now kindly redirect to our workflow registry <https://workflowhub.eu/>, their framework was renamed to "WfCommons" and moved to <https://wfcommons.org/> and their Python package `workflowhub` was renamed [`wfcommons`](https://pypi.org/project/wfcommons/).

See the list of club members on the [acknowledgement](/project/acknowledgements) page.

## Code of conduct

This project has a [Code of Conduct](https://github.com/workflowhub-eu/about/blob/master/CODE_OF_CONDUCT.md) to ensure interactions are friendly, respectful and inclusive. You can contact <[email protected]> if you have any concerns or questions.

## Citation

{% include citation.md %}
## Retention and End-of-Life policy

WorkflowHub's sustainability plan is to ensure the availability of its contributions and metadata up to and beyond 2027. If and when the WorkflowHub reaches its end of service after that, the published contributions and metadata will be archived as RO-Crates and made available through a public repository, such as Zenodo, Figshare or another appropriate resource at that time. [DOI registrations](/docs/citable/) will in this case be updated to link to the archived deposits.


## Governance

{% include contributor-tiles-all.html custom="Johan Gustafsson, Frederik Coppens, Carole Goble" %}


## Acknowledgements

Expand All @@ -73,3 +125,10 @@ We are grateful for contributions from [**EOSC-Life**](https://www.eosc-life.eu
<!-- NOTE: Always update list above AND the acknowledgements.md page -->









9 changes: 8 additions & 1 deletion project/acknowledgements.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Acknowledgements
sidebar: false
---

Main development, hosting and maintenance of WorkflowHub is done by the [eScience Lab](https://esciencelab.org.uk/) at The University of Manchester led by [Carole Goble](https://research.manchester.ac.uk/en/persons/carole.goble).


## Funding

<!-- NOTE: Always update list below AND section on the index.md page -->
Expand All @@ -24,12 +26,14 @@ We are also grateful for contributions by:
* [BIOINDUSTRY 4.0](https://www.ibisba.eu/EU-Projects/Horizon-Europe) ([HORIZON-INFRA-2022-TECH-01 101094287](https://doi.org/10.3030/101094287), [UKRI 10048146](https://gtr.ukri.org/projects?ref=10048146))
* ..in addition to contributions from [WorkflowHub Club](#workflowhub-club) participants


### EOSC-Life

{% include affiliation-tiles-selection.html type="EOSC-Life"%}

workflowhub.eu was founded as part of [**EOSC-Life**](https://www.eosc-life.eu/) ([WP2 _Tools Collaboratory_](https://github.com/eosc-life/tools-collaboratory-roadmap)), funded by European Union’s [Horizon 2020](https://ec.europa.eu/programmes/horizon2020/) programme under grant agreement [H2020-INFRAEOSC-2018-2 824087](https://doi.org/10.3030/824087).


### Previous funding

{% include affiliation-tiles-selection.html type="previous"%}
Expand All @@ -48,6 +52,7 @@ Previous contributions were funded by:

The main [WorkflowHub codebase](https://github.com/seek4science/seek/tree/workflowhub) is based on [SEEK](https://seek4science.org/about_us.html) and builds on previous experience with developing [myExperiment](https://www.myexperiment.org/about). SEEK is implemented in [Ruby on Rails](https://rubyonrails.org/) using a wide range of open source [Ruby gems](https://github.com/seek4science/seek/blob/workflowhub/Gemfile.lock).


## Related projects

### ELIXIR
Expand All @@ -65,6 +70,7 @@ WorkflowHub activities are strongly coordinated with [ELIXIR Europe](https://eli
* [ELIXIR Netherlands](https://www.elixir-europe.org/about-us/who-we-are/nodes/netherlands)
* [ELIXIR Hub](https://elixir-europe.org/about-us/who-we-are/hub)


### Collaborations

The WorkflowHub community collaborates closely with (at least) these projects:
Expand All @@ -78,9 +84,10 @@ The WorkflowHub community collaborates closely with (at least) these projects:
* [FAIRDOM](https://fair-dom.org)
* [FAIRDOM-SEEK](https://fairdomseek.org/)


## WorkflowHub Club

The weekly [WorkflowHub Club](/project/community) is chaired by **Finn Bacall**.
The weekly [WorkflowHub Club](/project/community) is chaired by **Johan Gustafsson**.

Participants include:

Expand Down
3 changes: 3 additions & 0 deletions project/citation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Citation
sidebar: false
---

{% include citation.md %}

{% include callout.html type="tip" content="See also [publication and outreach](/project/outreach) for more specific work." %}
Loading

0 comments on commit ec22a49

Please sign in to comment.