Open jaeddy opened 4 years ago
I'm using Hubflow for one of my repo and have successfully run gh-openapi-docs
on a branch named feature/<something>
. Note that the openapi specification files and the folder docs
have been saved to preview/feature/<something>/
. I was positively surprise to see this operation succeed. I haven't reviewed the code yet to understand how gh-openapi-docs
interacts with the branch gh-pages
of a repo, but at least I can confirm that the documentation was successfully built locally in the case described above.
A few of the GA4GH Cloud WS repos strongly encourage use of the Hubflow by contributors. The main impact relevant to this package is the prescribed naming of branches — i.e.:
Other branch prefix options include
release/
andhotfix/
. Nominally, this would result in the branch "type" being an explicit part of the docs URL in GH Pages. That is, instead ofhttps://ga4gh.github.io/<repoName>/preview/issue-123-improving-the-docs/docs
it would behttps://ga4gh.github.io/<repoName>/preview/feature/issue-123-improving-the-docs/docs
.I want to double check two things: