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

deploy to github-pages #61

Merged
merged 4 commits into from
Oct 28, 2019
Merged

deploy to github-pages #61

merged 4 commits into from
Oct 28, 2019

Conversation

casperdcl
Copy link
Member

@casperdcl casperdcl commented Oct 22, 2019

We already rely on GitHub pages for the main site (https://github.com/openworm/openworm.github.io).

@casperdcl casperdcl requested review from cheelee and mwatts15 October 22, 2019 22:50
@casperdcl casperdcl self-assigned this Oct 22, 2019
@casperdcl casperdcl mentioned this pull request Oct 22, 2019
1 task
@casperdcl casperdcl requested a review from balicea October 22, 2019 22:52
@casperdcl casperdcl mentioned this pull request Oct 22, 2019
Copy link
Contributor

@mwatts15 mwatts15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add some comments where you're using keys or values that are from or dictated by external systems (e.g., "Why do we need to filter out gh-pages"). We want our documentation build system to be well-documented as well!

(Also, if we're abandoning rtd.org, are you thinking of a solution for hosting docs that are work-in-progress? Is that just another gh-pages* branch? We will have releases of OpenWorm, so I expect we'll have a long-lived development branch for docs as well. Not expecting it for this review though.)

@casperdcl
Copy link
Member Author

casperdcl commented Oct 23, 2019

@mwatts15 work-in-progress docs are already accessible via the circleci builds I set up! for example, https://407-12814245-gh.circle-artifacts.com/0/home/circleci/repo/site/gsod19/repos/index.html is from navigating the artifact tree in https://circleci.com/gh/openworm/openworm_docs/407#artifacts/containers/0 which is WIP from #58

@mwatts15
Copy link
Contributor

@mwatts15 work-in-progress docs are already accessible via the circleci builds I set up! for example, https://407-12814245-gh.circle-artifacts.com/0/home/circleci/repo/site/gsod19/repos/index.html is from navigating the artifact tree in https://circleci.com/gh/openworm/openworm_docs/407#artifacts/containers/0 which is WIP from #58

That's pretty sub-optimal: That doesn't give me a stable link to the latest documentation and the Circle-CI artifact view isn't reflective of the target deployment. I can't use most of the hyperlinks from there either.

@casperdcl
Copy link
Member Author

@mwatts15 I agree it's clunky - I'll open a new issue regarding making it easier to see. Shouldn't be too hard to find a solution (depending on how important you think it is).

@casperdcl casperdcl merged commit 51ea850 into master Oct 28, 2019
@casperdcl casperdcl deleted the gh-deploy branch October 28, 2019 10:48
@casperdcl casperdcl mentioned this pull request Oct 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

use gh-pages
2 participants