search

ga4gh / workflow-execution-service-schemas

The WES API is a standard way to run and manage portable workflows.
Apache License 2.0
82 stars 38 forks source link

Add ReadTheDocs for user/developer documentation #129

Open jaeddy opened 5 years ago

jaeddy commented 5 years ago

See https://data-object-service.readthedocs.io/en/latest/ for an example (related DRS issue here: https://github.com/ga4gh/data-repository-service-schemas/issues/56).

sumit-158 commented 2 years ago

@jaeddy can I work on this?? if yes, could you please help me how to get started!!

jaeddy commented 2 years ago

Hi @sumit-158 - apologies for the slow reply! I haven't had the bandwidth to pay as much attention to this repo for a while. You're definitely welcome to work on this (obviously assuming you follow our standard CONTRIBUTING guidelines — basically, fork and open a PR).

There's a tutorial to get you started here, but I'd also check with @jb-adams about setting up accounts, choosing which branch to work off of, and integrating with build systems.

jb-adams commented 2 years ago

hi @sumit-158 thanks for your interest in contributing to the WES specification. Please fork this repo to your own workspace, and create a new branch off of ga4gh:develop. Once you are ready, you can submit a PR back to ga4gh:develop.

It's also helpful if you include the issue number in your branch name, e.g. feature/issue-129-read-the-docs

sumit-158 commented 2 years ago

Hi @jb-adams , do I have to change this readme.md

jb-adams commented 2 years ago

not sure why that's there, it seems to just be a link to the built docs. So I'd say the README might be able to be deleted. @jaeddy what do you think?

jaeddy commented 2 years ago

That was just so if someone were to navigate to the docs/ folder within the GH repo, they could be directed to the full, rendered docs page. If there's a collision with ReadTheDocs content, feel free to delete. Otherwise, it might be worth amending to include something like:

View [user and developer documentation](some readthedocs url) for the Workflow Execution Service API.