elixir-cloud-aai / cwl-WES

Trigger CWL workflows via GA4GH WES and TES
Apache License 2.0
16 stars 18 forks source link

Some inconsistencies in the documentation #237

Closed sgalpha01 closed 2 years ago

sgalpha01 commented 2 years ago

Describe the bug Technically it's not a bug with programs, but there are some issues in the doc.

Issues

  1. cloning the repo in the directory name app
  2. the grep command looks for cwl-wes_wes-worker, but due to issue (1), it's not present
  3. Wrong port is used in the example as it does not match with docker-compose file

Expected documentation

  1. the repo can be downloaded as it is.
  2. grep should look for _wes-worker instead of cwl-wes_wes-worker
  3. Port should be updated to 8080
sgalpha01 commented 2 years ago

Should I go ahead and edit the Readme file?

uniqueg commented 2 years ago

Yes, please - if it's not too late. Sorry, I'm just getting around going through all my GH notifications.