Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use gh-openapi-docs tool and integrate with CI #106

Open
jb-adams opened this issue Aug 26, 2021 · 4 comments
Open

use gh-openapi-docs tool and integrate with CI #106

jb-adams opened this issue Aug 26, 2021 · 4 comments

Comments

@jb-adams
Copy link

The gh-openapi-docs tool is being used by several Cloud WS specifications (DRS, WES). It automatically builds documentation and pushes it to the website (ie. gh-pages branch) at a URL path that is based on the github branch name. We could use this in RNAget to streamline the previewing of features, as well as for new releases.

I set this tool up for DRS and would be good to set it up here if we're interested. The current page structure we have in gh-pages is modelled on how the tool writes new files/directories for new docs.

@saupchurch @emi80 WDYT? Is this worth setting up for RNAget?

@emi80
Copy link
Member

emi80 commented Sep 8, 2021

Hi @jb-adams,
It sounds like a good idea as it would make docs more uniform across different GA4GH "products". In my opinion it is definitely worth setting it up for RNAget.

If we go for it, just let me know if you need anything from my side.

@jb-adams
Copy link
Author

jb-adams commented Sep 8, 2021

Thanks @emi80 !

@saupchurch do we want to set this up? If you approve, I can start the branch

@saupchurch
Copy link
Contributor

I agree, this would be very helpful to have.

@jb-adams
Copy link
Author

Great, I will start a branch to set this up.

Thanks @emi80 and @saupchurch !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants