You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@jclouds.apache.org by Andrew Phillips <no...@github.com> on 2014/04/29 19:26:45 UTC

[jclouds-site] First experiment with Javadoc iframe (#93)

Work in progress. Please do **not** merge as yet.
You can merge this Pull Request by running:

  git pull https://github.com/jclouds/jclouds-site add-jdoc-iframe

Or you can view, comment on it, or merge it online at:

  https://github.com/jclouds/jclouds-site/pull/93

-- Commit Summary --

  * First experiment with Javadoc iframe

-- File Changes --

    A reference/javadoc/1.7.2/index.md (5)

-- Patch Links --

https://github.com/jclouds/jclouds-site/pull/93.patch
https://github.com/jclouds/jclouds-site/pull/93.diff

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
> Will there be another PR for linking this to the Documentation menu somehow?

Please suggest where or simply update this PR? It's a branch in jclouds-site.git in ASF, so you should be able to access it. We'll probably also want at least a link for labs-openstack Javadocs, too...so we'll need to figure out a slightly different scheme involving adding the repo to the URL for now?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41712567

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://eac22fef0af34f5dc85b-c8ac35824a36a09ed3433a058a1265ec.r60.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41764454

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Jeremy Daggett <no...@github.com>.
@demobox Yes, it looks great! Will there be another PR for linking this to the Documentation menu somehow?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41712004

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #293](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/293/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42135466

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
> I kicked some ideas around yesterday on how we could solve this problem in the long term.

How about a Maven project that contains all the others as dependencies, unzips all the source files, and builds Javadoc for all of them? Would be a huuuge build, but worth trying?


---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41952209

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
@demobox Why the difference in L&F between [jclouds](http://eac22fef0af34f5dc85b-c8ac35824a36a09ed3433a058a1265ec.r60.cf1.rackcdn.com/reference/javadoc/1.7.2/jclouds/) & [jclouds-labs-openstack](http://eac22fef0af34f5dc85b-c8ac35824a36a09ed3433a058a1265ec.r60.cf1.rackcdn.com/reference/javadoc/1.7.2/jclouds-labs-openstack/)?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41951416

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://30164db58705e052571b-957c16a619dc2f6254d229abbe628b81.r53.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41706312

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
@jdaggett @everett-toews Ping...thoughts on this? Try this for now, or drop and try to go straight for a more "complete" solution.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41929250

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
Yes. I mean getting rid of /reference/javadoc/HEAD/ and everything under it for now. Providing the HEAD docs has marginal value anyway. If we can find a good way to automate producing those docs, we could bring them back later.

Shall I add a commit for that?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42486737

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
> Merged and deployed.

Thanks! PS: Are the credentials used to upload this to Cloud Files shared anywhere?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42549572

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #297](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/297/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42489110

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://e6c777d55b396d2ec752-2b2e45090128685dfbbcdf08d9c4585b.r7.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42493117

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
Merged the Javadoc for 1.7.2 and put it on Cloud Files. Left HEAD as is for now for contrast. Added a Javadoc menu item to Documentation.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42136426

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #288](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/288/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41764366

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://fe698893c63628741e1b-8e049734fd4c243e8136a58c64f74b6b.r3.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41763153

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
@everett-toews @jdaggett What do you think..?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41834241

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
>  I'd like to remove the 1.8.0-SNAPSHOT stuff first though. It looks awful and is confusing.

You mean the iframe to the HEAD Javadocs..?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42482951

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Jeremy Daggett <no...@github.com>.
@demobox Its really too bad that both can't be in the same docs! Maybe we can have another menu item called "JavaDocs" that links to the current released version for the main jclouds project. Another suggestion would be to create a "JavaDocs" landing page similar to the "Release Notes" page containing docs for all of the sub-projects (which we don't have right now). Then we could move these pages under the "Documentation" menu. Placing the JavaDocs in the Release Notes seems very unintuitive to me and forces the developer to search for them. It should be right in their face! @everett-toews WDYT?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41836815

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
> Shall I add a commit for that?

Yes, please!

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42487283

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #286](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/286/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41706047

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
Looks OK so far:

![image](https://cloud.githubusercontent.com/assets/223702/2832607/644c41ce-cfc6-11e3-93fd-1b0003bd1bbb.png)


---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41708497

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
@everett-toews: Ping? Thoughts on this?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42409793

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
Or it could be just select others as dependencies. Those that want to opt-in rather than just taking everything by default.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41952541

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
>  I'd like to remove the 1.8.0-SNAPSHOT stuff first though. It looks awful and is confusing.

Agree that it's more of a developer resource. I'll create a Wiki page for it. Personally, I'm not so concerned about the formatting...it's the standard Javadoc style, after all. But it's indeed curious why the CSS is not correctly applied.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42518653

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
@demobox Ping me on IRC and we can discuss there.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42553209

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #298](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/298/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42492618

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
+1 - looks good to me. Thanks, @everett-toews! Just a squash'n'rebase to go for now, I guess?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42490333

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
Thanks, @everett-toews! How much work was the merged version? The only thing I'm curious about is the title "Apache jclouds 1.7.2 API":

![image](https://cloud.githubusercontent.com/assets/223702/2874323/d7b1ba12-d3e1-11e3-88f5-e34b6ab953f7.png)

Do you think there is a chance people will not be sure whether this also contains the labs stuff? I don't know how you generated it, but if we try to do it programmatically, would it make sense to change the title to be something like "jclouds 1.7.2 API (includes labs repos)" or so?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42150367

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #287](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/287/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41763061

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
Closed #93.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#event-119117236

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://4f1de85858b190412486-076111318eb14ff5a939a6d7235c1391.r1.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42135542

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Everett Toews <no...@github.com>.
Merged and deployed.

Thanks @demobox!

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42547259

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Jeremy Daggett <no...@github.com>.
@demobox Thanks for pointing out the JIRA commentary! I think this is a great first step and we should make it so. Let's see what @everett-toews thinks about it.

Having separate repos is really problematic for aggregating JavaDocs into a single set. I don't think its possible the way our repos are laid out at the moment. :(

I kicked some ideas around yesterday on how we could solve this problem in the long term. I wonder if git subtree would be an option here for pulling in the other repos into a single location under jclouds/jclouds. ?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41931543

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by jclouds-commentator <no...@github.com>.
  Go to http://3aeced2f7be4771f23af-a672cda7faec70cb95bb6e4167fd5a12.r38.cf1.rackcdn.com/ to review your changes.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-42489785

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
>  Its really too bad that both can't be in the same docs!

@jdaggett: See [this comment](https://issues.apache.org/jira/browse/JCLOUDS-147?focusedCommentId=13984493&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13984493) in the JIRA issue. And this is certainly not intended as the desired "end-state"...just wondering if it would make sense to merge this now so we at least have _something_ and figure out a better solution then?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41840924

Re: [jclouds-site] JCLOUDS-147: First experiment with Javadoc iframe (#93)

Posted by Andrew Phillips <no...@github.com>.
> Why the difference in L&F between jclouds & jclouds-labs-openstack?

*sigh*. See the [publishing guide](https://wiki.apache.org/jclouds/Publishing%20API%20docs#Updating_aggregate_Javadocs). Unfortunately, on our _main_ build we actually have to regenerate the aggregate Javadocs because the Jenkins build fails.

The jclouds-labs-openstack docs build works in Jenkins, and for some odd reason the CSS styles don't get pulled it. If we want to align them, we can run the jclouds-labs-openstack aggregate build again locally and re-publish?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/93#issuecomment-41958449