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

Publish documentation on clusterhq.com #29

Closed
robhaswell opened this issue Jun 4, 2014 · 7 comments · Fixed by #413
Closed

Publish documentation on clusterhq.com #29

robhaswell opened this issue Jun 4, 2014 · 7 comments · Fixed by #413

Comments

@robhaswell
Copy link
Contributor

No description provided.

@itamarst
Copy link
Contributor

itamarst commented Jun 4, 2014

  1. We should probably wait until we have open source release and project name.
  2. We should use our own domain.
  3. We will want to use our own theme... we need to make sure RTD supports this.

Also, automating releases on RTD may not be possible, so we might just decide it's better to host our own.

@itamarst itamarst changed the title Set up flocker.readthedocs.org Publish documentation on clusterhq.com Jun 26, 2014
@wallrj
Copy link
Contributor

wallrj commented Jul 16, 2014

Project name is decided and it's now open source. So moved this from blocked to ready.

@tomprince tomprince self-assigned this Jul 16, 2014
@lukemarsden
Copy link
Contributor

Let's put this at clusterhq.com/docs, as a static content sphinx build. You can upload to that via SCP. Buildbot already does sort of automatic upload for docs.hybridcluster.com.

@lukemarsden
Copy link
Contributor

(Let me know if you'd like me to configure a SSH public key to be able to authenticate to clusterhq.com).

@tomprince
Copy link
Contributor

The release process (#293) currently builds docs on RTD, which show up at docs.clusterhq.com. It would also be possible to proxy to RTD (from cloudfront?), to get it show up at at /docs.

If buildbot is going to upload docs automatically, the SSH key shouldn't ever touch the slaves, it should just be on the master. (Eventually the slaves are probably going to be running somewhat untrusted code).

On the other hand, while I think the release process should be automated, I don't think the thing that triggers that automation should be somebody creating a tag or a branch in the repository.

@robhaswell
Copy link
Contributor Author

Our website will be converted to Docker hosting with an nginx frontend (https://www.pivotaltracker.com/story/show/75340328) for the launch, which could be an alternative for performing the proxying.

@itamarst
Copy link
Contributor

itamarst commented Aug 4, 2014

We decided to go with docs.clusterhq.com on readthedocs. If that turns out to be a problem we can reopen this, otherwise we're all set.

@itamarst itamarst closed this as completed Aug 4, 2014
@itamarst itamarst removed the ready label Aug 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants