search

elixir-cloud-aai / krini

Run & manage life science analyses
https://krini.rahtiapp.fi/
Apache License 2.0
4 stars 6 forks source link

docs: Making docs more verbose #17

Open SohamRatnaparkhi opened 1 year ago

SohamRatnaparkhi commented 1 year ago

Is your feature request related to a problem? Please describe. When attempting to run a workflow locally on the localhost, we are currently redirected to the production deployment of Krini, which can be found at this. This redirection prevents contributors from being able to view the changes they make to the ./src/components/RunWorkflow.js file.

Describe the solution you'd like In the ./src/config.js, host_uri points to the production deployment, but if this points to development deployment then the issue can be solved

Additional context It is likely that host_uri is set to point to the production deployment because it is intended for public viewing. However, we can instruct contributors not to commit any changes made in the config.js file during a pull request.

SohamRatnaparkhi commented 1 year ago

Hi @git-anurag-hub, I would love to work on this issue. Can you assign it to me? Thank you!

anuragxxd commented 1 year ago

Hey @SohamRatnaparkhi, thanks for the issue but this issue will be solved on the merging of pr #16 !

Again thanks for the contribution.

uniqueg commented 1 year ago

@SohamRatnaparkhi: Thanks for reporting and offering to work on this. By the way, the issue has a tempting title. It almost made me believe we had some kind of documentation... 🙃😆

Anyway, did merging #16 fully solve this issue? If not, maybe you could tell us what's left to do, and maybe do it :) Otherwise, perhaps you could work on the issue that you youself suggested "making the docs more verbose" ;-)

We most definitely need documentation of the current features (not that many). That is, some screenshots with a bit of description (login, run a workflow, etc.). Something to build on anyway, as we will be adding more features.

Not the most exciting issue, though, so it's totally understandable if you'd rather want to look for something more code-oriented :)