Skip to content
This repository has been archived by the owner on Apr 5, 2018. It is now read-only.

Commit

Permalink
Add description of default branches
Browse files Browse the repository at this point in the history
  • Loading branch information
denis-yuen committed Sep 16, 2016
1 parent b6d1db1 commit ec641d6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
6 changes: 5 additions & 1 deletion app/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ We can also provision input and output files from and to HTTP, ftp, and S3. We a

## What environment do you test tools in?

Typically, we test running tools in Ubuntu Linux 14.04 LTS and 16.04 LTS on VMs in [OpenStack](https://www.openstack.org/) with 8 vCPUs and 96 GB of RAM and above. If you are only listing and editing tools, we have achieved success with much lower system requirements. However, launching tools will have higher system requirements dependent on the specific tool. Consult a tool's README when in doubt.
Typically, we test running tools in Ubuntu Linux 14.04 LTS and 16.04 LTS on VMs in [OpenStack](https://www.openstack.org/) with 8 vCPUs and 96 GB of RAM and above. If you are only listing and editing tools, we have achieved success with much lower system requirements. However, launching tools will have higher system requirements dependent on the specific tool. Consult a tool's README when in doubt.

## There are too many versions of my tool, how do I delete some?

Versions of your tool for most tools are harvested from the list of Tags for an image on quay.io, [as an example](https://quay.io/repository/pancancer/pcawg-bwa-mem-workflow?tab=tags). If you have the right permissions, you can delete some and then refresh a tool on Dockstore to clean-up.

## Do you have tips on creating Dockerfiles?

Expand Down
5 changes: 5 additions & 0 deletions app/docs/getting-started-with-dockstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ Now select the `collaboratory/dockstore-tool-bamstats` repository and click "Pub

You can also click on the "Versions" tab and should notice `1.25-3` is present and Valid=Yes. If any versions are invalid it is likely due to a path issue to the `Dockstore.cwl`, `Dockerfile`, or `Dockstore.wdl` (if used) files. In BAMStats I used the default value of `Dockstore.cwl` and `Dockerfile` in the root repo directory so this was not an issue.

![Publish](docs/versions_toggle.png)

Next, pick a version of your tool that you wish to present to the world by clicking on the radio selector in the Git Reference column. This will determine which version of your CWL/WDL file will be used to find the author, email, and description in the case that it changes between versions. This also allows you to pre-select a version of your tool to present to users in the "Launch With" section, and the Dockerfile and Descriptor tabs.


#### Manual Registration of Tools

Outside of this tutorial, in certain cases, it is not possible for Dockstore to register every existing tool, especially those with unusual project structures. Most notably, Docker Hub images can not be automatically detected by Dockstore. The second possibility is that you have multiple CWL documents in a GitHub repository associated with multiple images. For those cases, it is necessary to manually register their details to Dockstore.
Expand Down

0 comments on commit ec641d6

Please sign in to comment.