Skip to content

Commit

Permalink
More readme updates [no JIRA] (#6135)
Browse files Browse the repository at this point in the history
  • Loading branch information
aednichols committed Dec 16, 2020
1 parent 5511e23 commit 25ae72e
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Expand Up @@ -9,10 +9,27 @@ The [Cromwell documentation has a dedicated site](https://cromwell.readthedocs.i

First time to Cromwell? Get started with [Tutorials](https://cromwell.readthedocs.io/en/stable/tutorials/FiveMinuteIntro/).

### Community

Thinking about contributing to Cromwell? Get started by reading our [Contributor Guide](CONTRIBUTING.md).

Cromwell has a growing ecosystem of community-backed projects to make your experience even better! Check out our [Ecosystem](https://cromwell.readthedocs.io/en/stable/Ecosystem/) page to learn more.

Talk to us:
- [Join the Cromwell Slack workspace](https://join.slack.com/t/cromwellhq/shared_invite/zt-dxmmrtye-JHxwKE53rfKE_ZWdOHIB4g) to discuss the Cromwell workflow engine.
- [Join the OpenWDL Slack workspace](https://join.slack.com/t/openwdl/shared_invite/zt-ctmj4mhf-cFBNxIiZYs6SY9HgM9UAVw) to discuss the evolution of the WDL language itself.
- More information about WDL is available in [that project's repository](https://github.com/openwdl/wdl).

### Capabilities and roadmap

A majority of Cromwell users today run their workflows in [Terra](https://app.terra.bio/), a fully-managed cloud-native bioinformatics computing platform. See [here](https://support.terra.bio/hc/en-us/articles/360036379771-Get-started-running-workflows) for a quick-start guide.

Users with specialized needs who wish to install and maintain their own Cromwell instances can [download](https://github.com/broadinstitute/cromwell/releases) a JAR or Docker image. The development team accepts reproducible bug reports from self-managed instances, but cannot feasibly provide direct support.

[Cromwell's backends](https://cromwell.readthedocs.io/en/stable/backends/Backends/) receive development resources proportional to customer demand. The team is actively developing for Google Cloud and AWS. Maintenance of other backends is primarily community-based.

Cromwell [supports](https://cromwell.readthedocs.io/en/stable/LanguageSupport/) the WDL and CWL workflow languages. The Cromwell team is actively developing WDL, while maintenance for CWL is primarily community-based.

### Issue tracking in JIRA

<!--
Expand All @@ -21,8 +38,8 @@ AEN external issue filing tested 2020-12-08 with `oednichols@gmail.com` / `https

Need to file an issue? Head over to [our JIRA](https://broadworkbench.atlassian.net/jira/software/c/projects/CROM/issues). You must create a free profile to view or create.

![Cromwell JIRA](docs/img/cromwell_jira.png)
[Issues in Github](https://github.com/broadinstitute/cromwell/issues) remain available for discussion among community members but are not actively monitored by the development team.

Issues in Github remain available for discussion among community members but are not actively monitored by the development team.
![Cromwell JIRA](docs/img/cromwell_jira.png)

![Jamie, the Cromwell pig](docs/jamie_the_cromwell_pig.png)

0 comments on commit 25ae72e

Please sign in to comment.