Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Basic automation for publishing documentation #604

Merged
merged 5 commits into from
Apr 28, 2015

Conversation

errordeveloper
Copy link
Contributor

This will build and upload docs on branch and tag pushes.

For each commits in any branch on upstream fork a documentation URL would look like:

http://docs.weave.works/weave/<branch>/<commit>/[index.html]

There will also be a pointer to latest commit:

http://docs.weave.works/weave/<branch>/[index.html]

For each tag there will be a shorter URL like:

http://docs.weave.works/weave/<tag>/[index.html]

I have manually uploaded latest_tag and v0.10.0.

After this is merged, the place to find latest development documentation is:
docs.weave.works/weave/master

@errordeveloper
Copy link
Contributor Author

This is a very simple version which I'm happy with. I am thinking that it should be merged as is and other improvements can be done in a separate pull-request.

@errordeveloper errordeveloper force-pushed the build-and-pubslish-docs-site branch from a01694b to f29d946 Compare April 24, 2015 09:41
@rade
Copy link
Member

rade commented Apr 24, 2015

Re the "Results"..., it shows

Installation Notes

  • Using with boot2docker
  • Using with systemd

In the absence of any other Installation items in the surrounding list, that does risk conveying the impression that these are the only two ways to install weave.

@errordeveloper
Copy link
Contributor Author

In the absence of any other Installation items in the surrounding list, that does risk conveying the impression that these are the only two ways to install weave.

Good point! The purpose of this change though is just to make docs build on Travis.

@errordeveloper
Copy link
Contributor Author

Any ideas what's up with coverage falling by -0.21%?

@tomwilkie
Copy link
Contributor

I've only got one request: could you make the credentials a tarball? I ask because we will want to put more credentials in there in the future, and we can only have one with travis.

Also, can you have build-and-publish.sh print the URL the docs have been published please.

I wouldn't worry about coverage; are you rebased on master?

@errordeveloper
Copy link
Contributor Author

I've only got one request: could you make the credentials a tarball? I ask because we will want to put more credentials in there in the future, and we can only have one with travis.

Didn't realise that it's only one file that can be encrypted... however I believe this cert can be used accessing all Google APIs, within that one project. Actually, I think that shell script that cats files into their destinations is neater then a tarball with a script that moves files around.

Also, can you have build-and-publish.sh print the URL the docs have been published please.

Sure, although I'd ultimately rather have it post a comment when it's a PR.

I wouldn't worry about coverage; are you rebased on master?

Yes.

@tomwilkie
Copy link
Contributor

Actually, I think that shell script that cats files into their destinations is neater then a tarball with a script that moves files around.

Fair enough; I don't feel too strongly about this.

Sure, although I'd ultimately rather have it post a comment when it's a PR.

That would also be nice, although I don't know how you'd achieve it.

@errordeveloper errordeveloper force-pushed the build-and-pubslish-docs-site branch 3 times, most recently from 2ee4dde to 2017aa6 Compare April 24, 2015 15:24
@errordeveloper
Copy link
Contributor Author

@tomwilkie there some details I have discovered here.

When Travis tests a pull-request, the branch it's on is actually the target branch and with our URL schema the result of building docs on a pull-request made to master will end-up stored under master/<commit> (the commit hash actually will never appear in the tree, it's just how Travis pretends to merge).

There are more details to it, but basically the only thing I can think of is to trigger docs to build on push to master (and other whitelisted branches). For preview of pull-request I think we will need a different URL schema, one that would look something like docs.weave.works/<project>/pr-<N>-<commit>/.

@errordeveloper errordeveloper force-pushed the build-and-pubslish-docs-site branch 6 times, most recently from 14af5a7 to 3a71e65 Compare April 27, 2015 16:28
@errordeveloper
Copy link
Contributor Author

Ready to merge.

@errordeveloper errordeveloper force-pushed the build-and-pubslish-docs-site branch from 3a71e65 to cfb8e75 Compare April 27, 2015 16:48
@errordeveloper
Copy link
Contributor Author

Updated description and rebased.

tomwilkie added a commit that referenced this pull request Apr 28, 2015
Basic automation for publishing documentation
@tomwilkie tomwilkie merged commit 840a493 into master Apr 28, 2015
@errordeveloper errordeveloper deleted the build-and-pubslish-docs-site branch April 28, 2015 09:25
@errordeveloper errordeveloper mentioned this pull request Apr 29, 2015
@rade rade modified the milestone: 0.11.0 May 12, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants