Awesome, this is great to see. If this works and is not problematic, let’s do it. Re adding 9.0, what is needed to do that?
Gj On Wednesday, October 3, 2018, Antonio <[email protected]> wrote: > Hi all, > > We now have https://netbeans.apache.org/javadoc/dev/index.html > > This is experimental. Things may be still syncing (if you see a 404 please > retry). Note that we're uploading .zip files for each module ([1], [2]) as > well. > > Jenkins job is at https://builds.apache.org/view > /Incubator%20Projects/job/incubator-netbeans-website-javadoc/ the initial > commit [3] is quite big: more than 13000 files and 3.3 million changes. > Subsequent commits should be smaller now that we have moved timestamps from > each HTML to the CSS. > > I'm not sure we decided the order of directories, I've used javadoc/dev > and not dev/javadoc as in bits.netbeans.org. I think we can use the > "javadoc" top directory to add information about javadoc itself (for > instance, the definitions of API stability, that right now point to > wiki.netbeans.org). > > Pending stuff and questions: > > - Continue with the "proxy" alternative Neil was talking about on another > thread (something similar to bits.netbeans.org). > - Update the current jbake website jenkins job to avoid removing the > "javadoc" directory whenever a change is published (pushing to the website > will remove javadocs right now). > - Update nbbuild/build.xml information with a "build-javadoc" entry. > - Update/review the misleading message ("build-javadoc is deprecated") > when "ant build-javadoc" is run on a pristine clone. > - Inform apache infra about build length to see if this is a problem > (there's a single node for building all Apache websites, and ours takes > almost half an hour). > - Generate and publish 9.0 javadoc (?) > - See how big commits are when javadoc is regenerated (see if the > timestamp fix is enough or if we need to improve it). > - Add a hook to regenerate javadoc when something is merged to > incubator-netbeans#master (?) > - Update the javadoc initial page (overview-summary.html) to add some > entries to Apache 9.0 javadoc? Also change links to FAQ and mailing lists. > > Cheers, > Antonio > > > [1] An example in Apache > https://netbeans.apache.org/javadoc/dev/org-netbeans-lib-v8debug.zip > > [2] Same in bits.netbeans.org > https://bits.netbeans.org/dev/javadoc/org-netbeans-lib-v8debug.zip > > [3] > https://github.com/apache/incubator-netbeans-website/commit/ > 03c1e9d2c924168ccfcaf46b968c63921aef71bb > > On 30/09/18 18:29, Antonio wrote: > >> Hi Gj, >> >> You may want to take a look at PR#930 [1], with a small fix to avoid >> adding timestamp to _all_ generated HTML files. This moves the timestamp >> info to javadoc.css instead. By doing so we will hopefully avoid adding >> 11349 files to each new commit when regenerating the javadoc. >> >> Note that timestamps are still included in some other files (those >> generated with the XSLT stylesheets), but these are just a few (as many as >> modules) and I think we can handle these in a future JIRA ticket. >> >> I'll try to create a Jenkins job in the coming days and continue with the >> javadoc demo. >> >> Kind regards, >> Antonio >> >> [1] >> https://github.com/apache/incubator-netbeans/pull/930 >> >> On 30/09/18 12:46, Geertjan Wielenga wrote: >> >>> That sounds great. If I can help in some way let me know, really keen to >>> have our javadoc published in one way or another. >>> >>> Gj >>> >>> >>> On Saturday, September 29, 2018, Antonio <[email protected]> wrote: >>> >>> Ok. Let's go for the demo. >>>> >>>> First let's add the timestamp on the javadocs inside the css only (with >>>> a >>>> footnote:before { content: "${TODAY}"} or something like that), and not >>>> on >>>> every HTML. >>>> >>>> Then the new jenkins job. Monday-tuesday could be a preliminar target >>>> for >>>> the demo. >>>> >>>> Regarding javadoc.io I think they require uploading the javadoc to >>>> Maven >>>> Central first, so that'll have to wait a little until we have the Maven >>>> artifacts in place with the new domain. >>>> >>>> Cheers, >>>> Antonio >>>> >>>> On 29/09/18 10:14, Geertjan Wielenga wrote: >>>> >>>> Well, let's see that demo first, with your Jenkins job, especially since >>>>> you can do it quickly. Based on that, we can decide if we like that >>>>> approach or not, once we see it in action, and then discuss >>>>> alternatives >>>>> if >>>>> needed at that stage. >>>>> >>>>> Gj >>>>> >>>>> On Sat, Sep 29, 2018 at 10:00 AM Antonio <[email protected]> wrote: >>>>> >>>>> >>>>> >>>>>> On 28/09/18 22:00, Neil C Smith wrote: >>>>>> >>>>>> On Fri, 28 Sep 2018, 20:07 Antonio, <[email protected]> wrote: >>>>>>> >>>>>>> 2- http://bits.netbeans.org/dev/javadoc/index.html >>>>>>> >>>>>>>> Requires the DNS stuff being in Apache, setting up a repo and a >>>>>>>> gitpubsub, will lose previous (5.0-8.2) javadocs. >>>>>>>> >>>>>>>> >>>>>>>> No it won't. The idea is to redirect 404s back to Oracle, same as >>>>>>> already >>>>>>> discussed with infra about the main website. >>>>>>> >>>>>>> >>>>>> Ah, I see, so we need Oracle to set up a "legacy.bits.netbeans.org" >>>>>> website with the current content, right? So that all 404s that reach >>>>>> bits.netbeans.org end up in legacy.bits.netbeans.org. Wasn't that the >>>>>> plan? >>>>>> >>>>>> I recall talking something about a proxy to make the whole thing >>>>>> transparent to the users, but I don't know the details. Maybe you want >>>>>> to lead this after wednesday? >>>>>> >>>>>> >>>>>> And possibly not /dev to start with, just /9.0 and /10.0? >>>>>>> >>>>>>> I suggested earlier not hosting the Javadocs under >>>>>>> netbeans.apache.org >>>>>>> >>>>>>> at >>>>>> >>>>>> least for now. We could rethink that later, but I think keeping it >>>>>>> away >>>>>>> from JBake would be a very good idea! >>>>>>> >>>>>>> >>>>>> There's a misunderstanding here, I think. >>>>>> >>>>>> Hosting the javadocs at netbeans.apache.org does not require JBake at >>>>>> all. It's just copying the generated javadocs in a directory inside >>>>>> the >>>>>> "content" directory in the "asf-site" branch: >>>>>> >>>>>> https://github.com/apache/incubator-netbeans-website/tree/ >>>>>> asf-site/content >>>>>> >>>>>> Adding stuff to a directory there and pushing to the "asf-site" branch >>>>>> should be good enough. I can set up a Jenkins job for this quickly if >>>>>> you want to see a demo. >>>>>> >>>>>> Anyway, shall we run a voting on the approach, including the >>>>>> javadocs.io >>>>>> idea from John? >>>>>> >>>>>> Thanks, >>>>>> Antonio >>>>>> >>>>>> >>>>>> But, yes, is there consensus / disagreement to that approach? >>>>>>> >>>>>>> Best wishes, >>>>>>> >>>>>>> Neil >>>>>>> >>>>>>> >>>>>>> >>>>>>>> >>>>>>> ------------------------------------------------------------ >>>>>> --------- >>>>>> To unsubscribe, e-mail: [email protected] >>>>>> For additional commands, e-mail: [email protected]. >>>>>> apache.org >>>>>> >>>>>> For further information about the NetBeans mailing lists, visit: >>>>>> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>> --------------------------------------------------------------------- >>>> To unsubscribe, e-mail: [email protected] >>>> For additional commands, e-mail: [email protected] >>>> >>>> For further information about the NetBeans mailing lists, visit: >>>> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists >>>> >>>> >>>> >>>> >>>> >>> > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > > For further information about the NetBeans mailing lists, visit: > https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists > > > >
