Re: [DOCS] Building for release - update round 2
David Crossley wrote: This highlights a huge misunderstanding. The docs must be generated and updated on the website as often as possible, not just at release time. True, but I was talking about the specific jars.html page for the upcoming release. Since we've decided that the 2.1 branch is going to be replaced by 2.2, I suppose there will hardly be any updates to the 2.1 docs, nor the jars.html page for the 2.1 branch. For the 2.2 release we can do it differently. Yes, I'm all for frequent updates of the docs website. The old way had some serious road blocks resulting in hardly any doc updates and very few website updates. The current way (editing in Daisy) removed the doc editing road block. We just have to figure out how we can make the conversion process from Daisy to website. If there was any misunderstanding it was my perception that Daisy could be used for both editing and official website. Bye, Helma
Re: [DOCS] Building for release - update round 2
hepabolu wrote: > David Crossley wrote: > > >Another issue is that the useful table of libraries used with > >Cocoon was generated by the Cocoon "docs" target by analysing > >gump.xml IIRC. > >http://cocoon.apache.org/2.1/installing/jars.html > >http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/installing/jars.html > > Hmm, could you generate this with the same workaround as the > changes.html page? No it cannot. As i said, it was an intergral part of the Cocoon "build.sh|build.bat" process. Then forrest just rendered it. The data needs to be prepared. > I guess this is a one time process, since it's Cocoon 2.1.8. So no use > to spend much time to setting up a nifty process if it's only used once > or twice. This highlights a huge misunderstanding. The docs must be generated and updated on the website as often as possible, not just at release time. -David > For Cocoon 2.2 we should find a different process. > > WDYT? > > Bye, Helma
Re: [DOCS] Building for release - update round 2
David Crossley wrote: Ross Gardler wrote: ... * Extra URI segments: Some of these are a result of the lack of a clean build space (i.e. about/), but others are the same problem with the daisy navigation, for example, the extra dirs under /userdocs/forms/ Helma did warns us that there were other places the URLspace had been changed in Daisy, I was hoping it would be less widespread than this though :-( I'm looking into it. What is the status of this? Did you produce a new list for Vadim, or someone else, to verify? I've been inundated with work lately and have been unable to do anything about this. It can be solved by the same method as the previous extra info in the URL space, however, in some places this will result in navigation docs that are too fragmented on Daisy. The other options are for us to put in the code to support extra nodes in the Daisy to allow "Title" nodes that do not have a corresponding URL entry. Bruno suggested this on the Daisy list so he is receptive to the idea, problem is finding the time to do it, I have no idea how easy/hard it is (Bruno said it would be fairly easy, but then Bruno knows Daisy code inside out ;-) .htaccess is a quick and dirty solution to get the release out. Butchering the Daisy nav docs will work, is quick and easy and can be reverted in 2.2 release. I'm afraid I am unlikely to get any real time on this until much later this week (possibly as late as Friday). So it's up to you folk. Ross Ross
Re: TOCs in documentation (Re: [DOCS] Building for release - update round 2)
David Crossley wrote: Ross Gardler wrote: Vadim Gritsenko wrote: Ross Gardler wrote: Vadim Gritsenko wrote: Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... It was moved there as a test, come people like it in the body, come in the page menu, some not at all. It is easy to move/remove (a setting in skinconf.xml in the daisy-to-docs module) - the question is where do we want it (or do we want to remove it). I am in "remove it completely" camp... On the Cocoon site, I am too, lets leave it for a while with the new subject line and see if anyone objects to us removing it completely. As i said earlier in this thread, i prefer the ToC in the top of the page body (probably listing only one level). I definitely do not like it in the side-panel menu. But really i don't care if others want it gone completely. I'' remove it completely. Some others have stated that they don't like it in the top. Ross
Re: [DOCS] Building for release - update round 2
hepabolu wrote: David Crossley wrote: There are a number of places in the source documents with the token "@released.version@", e.g. http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/index.html I'll see to this. I don't know how big a job this is. But if it is still worthwhile the Daisy plugin allows for Daisy documents to be pre and post filtered through and XSL. We can therefore automatically replace these tokens if you want to. Ross
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: Butchering the Daisy nav docs will work, is quick and easy and can be reverted in 2.2 release. Since it's the legacy docs, I don't mind. The 2.2. docs will use the other site and the other documentation collection. I don't mind doing it, since it's basically copy and paste, but I'd like to know which sections should be done apart from userforms/forms/ Bye, Helma
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: hepabolu wrote: David Crossley wrote: There are a number of places in the source documents with the token "@released.version@", e.g. http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/index.html I'll see to this. I don't know how big a job this is. But if it is still worthwhile the Daisy plugin allows for Daisy documents to be pre and post filtered through and XSL. We can therefore automatically replace these tokens if you want to. Done already, it was only 2 docs. Bye, Helma
Re: [DOCS] Building for release - update round 2
David Crossley wrote: generation. So someone will need to search Daisy and replace those tags. Just checked: there were 3, one of them retired. I changed it to (2.1.8) or (currently 2.1.8) whatever was more appropriate. The retired one, I didn't change. Bye, Helma
Re: [DOCS] Building for release - update round 2
David Crossley wrote: There are a number of places in the source documents with the token "@released.version@", e.g. http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/index.html I'll see to this. Another issue is that the useful table of libraries used with Cocoon was generated by the Cocoon "docs" target by analysing gump.xml IIRC. http://cocoon.apache.org/2.1/installing/jars.html http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/installing/jars.html Hmm, could you generate this with the same workaround as the changes.html page? I guess this is a one time process, since it's Cocoon 2.1.8. So no use to spend much time to setting up a nifty process if it's only used once or twice. For Cocoon 2.2 we should find a different process. WDYT? Bye, Helma
Re: [DOCS] Building for release - update round 2
There are a number of places in the source documents with the token "@released.version@", e.g. http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/index.html These are remnants of the previous build system, where the Cocoon build target "docs" used to copy the sources and replace those tokens, then forrest took over to do the generation. So someone will need to search Daisy and replace those tags. Another issue is that the useful table of libraries used with Cocoon was generated by the Cocoon "docs" target by analysing gump.xml IIRC. http://cocoon.apache.org/2.1/installing/jars.html http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/installing/jars.html -David
Re: TOCs in documentation (Re: [DOCS] Building for release - update round 2)
Ross Gardler wrote: > Vadim Gritsenko wrote: > >Ross Gardler wrote: > >>Vadim Gritsenko wrote: > >> > >>>Forgot to add... Can we loose page toc which now appears within left > >>>navigation bar? I'm not sure we should have it there, it certainly > >>>looks strange... > >> > >>It was moved there as a test, come people like it in the body, come in > >>the page menu, some not at all. > >> > >>It is easy to move/remove (a setting in skinconf.xml in the > >>daisy-to-docs module) - the question is where do we want it (or do we > >>want to remove it). > > > >I am in "remove it completely" camp... > > On the Cocoon site, I am too, lets leave it for a while with the new > subject line and see if anyone objects to us removing it completely. As i said earlier in this thread, i prefer the ToC in the top of the page body (probably listing only one level). I definitely do not like it in the side-panel menu. But really i don't care if others want it gone completely. -David
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: > Vadim Gritsenko wrote: > >Ross Gardler wrote: > > > >>I just sent it offlist, but I sent it from the zone, not sure if mail > >>is set up correctly there. If you don't recieive it you can get it at > >>http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/fileList.txt > > > >Got the mail ok. > > > >>(note this is not regenerated when the site is rebuilt) > > >Diff attached. Lots of differences, I'll sum up some of them here: > > Thanks for this Vadim, saves us lots of time - sorry it wasn't as > encouraging as I thought. > > > * Duplicates: See example above. Was it simply because output > >directory was not cleared up between forrest runs? > > Yes, that is the problem, as David identified. I'm discussing with David > as to whether the Forrestbot should always clear out its build directory > on a new run (I thought it did). I manually did that cleanout for now. > > * Extra URI segments: > > Some of these are a result of the lack of a clean build space (i.e. > about/), but others are the same problem with the daisy navigation, for > example, the extra dirs under /userdocs/forms/ > > Helma did warns us that there were other places the URLspace had been > changed in Daisy, I was hoping it would be less widespread than this > though :-( > > I'm looking into it. What is the status of this? Did you produce a new list for Vadim, or someone else, to verify? -David
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Vadim Gritsenko wrote: Ross Gardler wrote: Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. Cool stuff. Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... Vadim :-) it was moved there because it looks odd/old fashioned at the top of the page. Personally I don't mind if it's removed all together. Bye, Helma
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Ross Gardler wrote: I just sent it offlist, but I sent it from the zone, not sure if mail is set up correctly there. If you don't recieive it you can get it at http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/fileList.txt Got the mail ok. (note this is not regenerated when the site is rebuilt) .. Diff attached. Lots of differences, I'll sum up some of them here: Thanks for this Vadim, saves us lots of time - sorry it wasn't as encouraging as I thought. * Duplicates: See example above. Was it simply because output directory was not cleared up between forrest runs? Yes, that is the problem, as David identified. I'm discussing with David as to whether the Forrestbot should always clear out its build directory on a new run (I thought it did). * Extra URI segments: Some of these are a result of the lack of a clean build space (i.e. about/), but others are the same problem with the daisy navigation, for example, the extra dirs under /userdocs/forms/ Helma did warns us that there were other places the URLspace had been changed in Daisy, I was hoping it would be less widespread than this though :-( I'm looking into it. Ross
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: > > Hm, why some files are there twice? Example: > > /developing/concepts/avalon.html > /documentation/developing/concepts/avalon.html I know why. It is because the forrestbot didn't clean out its workspace on the server. So the old generated documents are still included. I will go do that Next run will be the actual set. -David
TOCs in documentation (Re: [DOCS] Building for release - update round 2)
Vadim Gritsenko wrote: Ross Gardler wrote: Vadim Gritsenko wrote: Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... It was moved there as a test, come people like it in the body, come in the page menu, some not at all. It is easy to move/remove (a setting in skinconf.xml in the daisy-to-docs module) - the question is where do we want it (or do we want to remove it). I am in "remove it completely" camp... On the Cocoon site, I am too, lets leave it for a while with the new subject line and see if anyone objects to us removing it completely. Ross
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: > Ross Gardler wrote: > >Vadim Gritsenko wrote: > > > >>Forgot to add... Can we loose page toc which now appears within left > >>navigation bar? I'm not sure we should have it there, it certainly > >>looks strange... > > > >It was moved there as a test, come people like it in the body, come in > >the page menu, some not at all. > > > >It is easy to move/remove (a setting in skinconf.xml in the > >daisy-to-docs module) - the question is where do we want it (or do we > >want to remove it). > > I am in "remove it completely" camp... I definitely don't like the ToC embedded in the left-hand menu. The top-of-page ToC is good though, e.g. see http://cocoon.apache.org/2.1/performancetips.html Though one day it would be good to utilise that whitespace. The ToC needs to be configured to less levels perhaps just one or maybe two levels. Otherwise some pages get confusing. -David
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: I just sent it offlist, but I sent it from the zone, not sure if mail is set up correctly there. If you don't recieive it you can get it at http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/fileList.txt Got the mail ok. (note this is not regenerated when the site is rebuilt) The two files forms/binding/binding.html and forms/binding/xmlbinding.html will become the correct files. The only other known problem at this stage is i18n-transformer is now i18nTransformer (see earlier mail) Hm, why some files are there twice? Example: /developing/concepts/avalon.html /documentation/developing/concepts/avalon.html Diff attached. Lots of differences, I'll sum up some of them here: * Duplicates: See example above. Was it simply because output directory was not cleared up between forrest runs? * Extra URI segments: /about /concepts (under /developing) /gettingstarted (under /faq) /sitemap(under /faq) /using (under /faq) /cocoon (under /howto) /contribution (under /howto) /documentation (under /howto) /testing(under /installing) /documentation (under /plan) /otherplanning (under /plan) /overview (under /plan) /api(under /userdocs/forms) /basics (under /userdocs/forms) /binding(under /userdocs/forms) /publishing (under /userdocs/forms) /widgetconcepts (under /userdocs/forms) /widgets(under /userdocs/forms) /sitemap-components (under /userdocs) /core (under /userdocs/sitemap-components/generators) /optional (under /userdocs/sitemap-components/generators) /core (under /userdocs/sitemap-components/matchers) /optional (under /userdocs/sitemap-components/matchers) /core (under /userdocs/sitemap-components/readers) /optional (under /userdocs/sitemap-components/readers) /scratchpad (under /userdocs/sitemap-components/readers) /core (under /userdocs/sitemap-components/selectors) /scratchpad (under /userdocs/sitemap-components/selectors) /core (under /userdocs/sitemap-components/serializers) /optional (under /userdocs/sitemap-components/serializers) /core (under /userdocs/sitemap-components/transformers) /optional (under /userdocs/sitemap-components/transformers) /logicsheets(under /userdocs/xsp) * Different URI segments: /snippets vs. /snippet Vadim --- docs-2.1-uris.txt 2005-11-11 09:53:45.542481600 -0500 +++ docs-new-uris.txt 2005-11-11 09:53:48.286427200 -0500 @@ -1,85 +1,381 @@ +/about/features.html +/about/license.html /bylaws-addendum.html -/catalog-test.html -/changes.html -/developing/avalon.html -/developing/datasources.html -/developing/deli.html -/developing/deliquick.html -/developing/extending.html -/developing/httprequest.html +/community/695.html +/community/697.html +/community/698.html +/community/699.html +/community/700.html +/community/701.html +/community/702.html +/community/703.html +/community/704.html +/community/705.html +/community/706.html +/community/bylaws-addendum.html +/community/who.html +/developing/concepts/avalon.html +/developing/concepts/datasources.html +/developing/concepts/deli.html +/developing/concepts/deliquick.html +/developing/concepts/extending.html +/developing/concepts/httprequest.html +/developing/concepts/parent-component-manager.html +/developing/concepts/source.html +/developing/concepts/stores.html /developing/index.html -/developing/parent-component-manager.html -/developing/portal/basket.html +/developing/portal/authentication.html /developing/portal/coplets.html +/developing/portal/coplets/cachinguricoplet.html +/developing/portal/coplets/uricoplet.html /developing/portal/events.html -/developing/portal/forms.html /developing/portal/index.html +/developing/portal/layout_skins.html /developing/portal/portal-block.html /developing/portal/profiles.html -/developing/source.html -/developing/stores.html +/developing/portal/samples/basket.html +/developing/portal/samples/forms.html +/developing/portal/wsrp.html /developing/web3.html /developing/webapps/authentication.html +/developing/webapps/authentication/application_management.html +/developing/webapps/authentication/authenticating_user.html +/developing/webapps/authentication/authentication-handler.html +/developing/webapps/authentication/module_management.html +/developing/webapps/authentication/pipeline_patterns.html +/developing/webapps/authentication/summary.html +/developing/webapps/authentication/user_administration.html +/developing/webapps/authentication/user_management.html /developing/webapps/contexts.html /developing/webapps/forms.html /developing/webapps/index.html /developing/webapps/portal.html /developing/webapps/session.html -/faq/faq-acti
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Ross Gardler wrote: Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. Cool stuff. Send me result of find . -name "*.html" I just sent it offlist, but I sent it from the zone, not sure if mail is set up correctly there. If you don't recieive it you can get it at http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/fileList.txt (note this is not regenerated when the site is rebuilt) The two files forms/binding/binding.html and forms/binding/xmlbinding.html will become the correct files. The only other known problem at this stage is i18n-transformer is now i18nTransformer (see earlier mail) Ross
Re: [DOCS] Building for release - update round 2
hepabolu wrote: Ross Gardler wrote: Two of the others had the same problem: 2.1/forms/binding.html and 2.1/forms/xmlbinding.html. Since this concerns only 2 files, just remove the grouping in Daisy so the url space matches. They both have "binding" in their label, so it should stand out in the menu. That solves the url change as well as the link problem. That makes sense, I did that, next build will show the change. The last one 2.1/userdocs/sitemap-components/transformers/core/i18n-transformer.html is a problem with Forrest. It uses a pattern of "**i18n-*.html" internally for some of its internationalisation stuff. This is obviously not good, I've raised an issue in Forrest, but it is too big a job fix now. I've therefore renamed this file to i18nTransformer as a workaround. But of course, this creates another change URL. so an .htaccess then? Yes, I think so. Ross
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: Vadim Gritsenko wrote: Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... It was moved there as a test, come people like it in the body, come in the page menu, some not at all. It is easy to move/remove (a setting in skinconf.xml in the daisy-to-docs module) - the question is where do we want it (or do we want to remove it). I am in "remove it completely" camp... Vadim
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Vadim Gritsenko wrote: Ross Gardler wrote: Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. Cool stuff. Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... It was moved there as a test, come people like it in the body, come in the page menu, some not at all. It is easy to move/remove (a setting in skinconf.xml in the daisy-to-docs module) - the question is where do we want it (or do we want to remove it). Ross
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Ross Gardler wrote: Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. Cool stuff. Forgot to add... Can we loose page toc which now appears within left navigation bar? I'm not sure we should have it there, it certainly looks strange... Vadim
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. Cool stuff. Send me result of find . -name "*.html" from http://forrest.zones.apache.org/ft/build/cocoon-docs/2.1/ and I'll compare with old url space (i don't have access to forrest.zones). Vadim
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: The first (2.1/index.html) didn't appear anywhere in the Daisy nav menu so Forrest had no way of knowing how to find it. I just added index to the About section. Fine. Two of the others had the same problem: 2.1/forms/binding.html and 2.1/forms/xmlbinding.html. Since this concerns only 2 files, just remove the grouping in Daisy so the url space matches. They both have "binding" in their label, so it should stand out in the menu. That solves the url change as well as the link problem. The last one 2.1/userdocs/sitemap-components/transformers/core/i18n-transformer.html is a problem with Forrest. It uses a pattern of "**i18n-*.html" internally for some of its internationalisation stuff. This is obviously not good, I've raised an issue in Forrest, but it is too big a job fix now. I've therefore renamed this file to i18nTransformer as a workaround. But of course, this creates another change URL. so an .htaccess then? Bye, Helma
Re: [DOCS] Building for release - update round 2
hepabolu wrote: Ross Gardler wrote: Note, somehow only the menu is up on forrest.zones, all linked pages are gone. I suspect this is due to the split in the navigation doc in Daisy and should be fixed when Ross adjusts the appropriate files in Forrest. I'm not seeing this. I see the full contents of the site, all looking lovely, with the corect URLspace. Are you still seeing this problem? Just checked: no everything seems fine. There are three broken links in the site build now, I'll look at those tomorrow morning (UTC), if someone else wants to have a go at it the broken links are shown on: http://forrest.zones.apache.org/ft/build/cocoon-docs/broken-links.xml IIUC there are four broken links, but I have no clue how to fix it, sorry. Yes, there were four. The first (2.1/index.html) didn't appear anywhere in the Daisy nav menu so Forrest had no way of knowing how to find it. I just added index to the About section. (NOTE there was a link to the index page used on daisy, but that is not the index page for the site so I removed that, you still see the daisy index when you go to the legacy docs on daisy itself). Two of the others had the same problem: 2.1/forms/binding.html and 2.1/forms/xmlbinding.html. The problem here is the fact that daisy does not allow grouping of documents without adding something to the path. There are only two files in this section of the navigation, so I don't think it is worth creating a separate nav document for them like we did with the higher level nodes, although that would solve the problem. I propose we either accept these as changed URLs and we add .htaccess rules for these two files. They are now at 2.1/forms/binding/binding.html and 2.1/forms/binding/xmlbinding.html If that is not acceptagble then someone needs to do as Helma did and create an import node for these two docs. The last one 2.1/userdocs/sitemap-components/transformers/core/i18n-transformer.html is a problem with Forrest. It uses a pattern of "**i18n-*.html" internally for some of its internationalisation stuff. This is obviously not good, I've raised an issue in Forrest, but it is too big a job fix now. I've therefore renamed this file to i18nTransformer as a workaround. But of course, this creates another change URL. I just did a test build and there are now no broken links. So, if our work has worked (next forrestbot build will confirm/deny this) we should be down to just three (or even one) changed URLs, quite manageable with an .htaccess file I think. Perhaps Vadim can create a diff for us again to check this status, once the build has completed in around 3 hours. For the future: Bruno has suggested a change (on the Daisy list) to Daisy that will allow us to Group items without affecting the urlspace. So we can fix this problem in future releases (there is another Daisy user needs this too, so hopefully one of us will implement it). We'll also fix the "i18n-" urlspace limitation in Forrest. Ross
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: > hepabolu wrote: > > > > -/changes.html > > > >This is so outdated (see http://cocoon.apache.org/changes.html) that I > >would be ashamed to put it up again. So it's missing from Daisy (also > >because it's toplevel) and therefore from forrest.zones. Not correct, please read the other recent threads about this. > This is generated from status.xml > (http://cocoon.apache.org/2.1/changes.html), same as todo.html. The reason that that page appears to be "outdated" is that no committers have found the wherewithall to update the website since the last release. These pages are generated, so if no-one does it then it doesn't happen. As i said in another thread there are hundreds of new entries recorded in the status.xml file. As i said in another thread i am still trying to find new ways to generate that since the old Cocoon-2.1 docs build is now broken. -David
Re: [DOCS] Building for release - update round 2
Ross Gardler wrote: Note, somehow only the menu is up on forrest.zones, all linked pages are gone. I suspect this is due to the split in the navigation doc in Daisy and should be fixed when Ross adjusts the appropriate files in Forrest. I'm not seeing this. I see the full contents of the site, all looking lovely, with the corect URLspace. Are you still seeing this problem? Just checked: no everything seems fine. There are three broken links in the site build now, I'll look at those tomorrow morning (UTC), if someone else wants to have a go at it the broken links are shown on: http://forrest.zones.apache.org/ft/build/cocoon-docs/broken-links.xml IIUC there are four broken links, but I have no clue how to fix it, sorry. Bye, Helma
Re: [DOCS] Building for release - update round 2
hepabolu wrote: Vadim Gritsenko wrote: Results are encouraging - now diff between old URI space and new version is much smaller (attached as well) Note that there are several numbered docs in there - either mislabelled old docs or newly added docs, i have not checked. Note, somehow only the menu is up on forrest.zones, all linked pages are gone. I suspect this is due to the split in the navigation doc in Daisy and should be fixed when Ross adjusts the appropriate files in Forrest. I'm not seeing this. I see the full contents of the site, all looking lovely, with the corect URLspace. Are you still seeing this problem? There are three broken links in the site build now, I'll look at those tomorrow morning (UTC), if someone else wants to have a go at it the broken links are shown on: http://forrest.zones.apache.org/ft/build/cocoon-docs/broken-links.xml They look like they are in the index file since they are referenced from a great many pages. Here are snippets of your diff that I want to comment on: I'll look at this later in the thread, after I have read Vadims response. Ross
Re: [DOCS] Building for release - update round 2
hepabolu wrote: Here are snippets of your diff that I want to comment on: > +/692.html > +/692.html > +/692.html I'm not sure where you found this one, Me too. Had this in locationmap src="http://publish:[EMAIL PROTECTED]:9263/publisher/document?documentId=692&includeNavigation=false&locale=en_US&version=live"/> because it doesn't show up on the forrest.zone set. In Daisy I used it to work around a little problem in the navigation doc: if a group contains only links to external pages, it doesn't open because there is no internal document to display. The content of this page is reflected in the forrest.zones set similar to the cocoon.apache.org set, with one exception: the "Links" section is not present in forrest.zones although it is present in Daisy. > -/catalog-test.html IIUC this is only present in the repository, but not on cocoon.apache.org and also not in Daisy. It is beyond me to grasp the value of this page, so AFAIC I won't put any effort into it to get it on the website. Again, this is toplevel, so that explains its absence as well. No this is not top level, everything in this diff is under /2.1/. I removed this document as its value was only for testing running Cocoon instance, and it is not needed to be on docs site. > -/changes.html This is so outdated (see http://cocoon.apache.org/changes.html) that I would be ashamed to put it up again. So it's missing from Daisy (also because it's toplevel) and therefore from forrest.zones. This is generated from status.xml (http://cocoon.apache.org/2.1/changes.html), same as todo.html. > +/developing/portal/authentication.html In the original site, this points to /developing/webapps/authentication.html. Although Daisy also refers to the same document, it is now available under two urls. No showstopper for me. > /developing/portal/coplets.html > +/developing/portal/coplets/cachinguricoplet.html > +/developing/portal/coplets/uricoplet.html The two pages below are extracted from the huge coplets.html file and put in separate pages to keep the info more readable. They can be reached through the menu see forrest.zones. There was an issue with an extra /portal/ in the url. I've fixed that. Only thing that remains are the samples: daisy export: /developing/portal/samples/forms.html + .../basket.html cocoon.apache.org: /developing/portal/forms.html + .../basket.html > +/developing/portal/layout_skins.html > +/developing/portal/wsrp.html New content > +/developing/webapps/604.html Fixed > +/developing/webapps/application_management.html > +/developing/webapps/authenticating_user.html > +/developing/webapps/module_management.html > +/developing/webapps/pipeline_patterns.html > +/developing/webapps/summary.html > +/developing/webapps/user_administration.html > +/developing/webapps/user_management.html Same as for the portal: this was all part of one huge "authentication.html" file. I've split it into different smaller files to keep it more readable. They are all in the menu. > -/installing/requirements.html Fixed > -/plan/changes-doc.html > -/plan/issues-doc.html > -/plan/review-sitemap-docs.html > -/plan/todo-doc.html These are very old and very outdated. The info is either done or not valid any more. When we want to have a "hip and modern" Cocoon, these pages provide the opposite signal. Since they deal with documentation only, I suggest to simply leave them out. If people think the information is worthwhile keeping, I suggest we either move them to Daisy but only for archiving purposes, or we move the info to the wiki. I'd prefer to remove them too. > -/todo.html IIUC this is genererated from status.xml, so I didn't do anything with this, although I think this is a good candidate for either Jira (most obvious place) or a Daisy document (easier to get an overview). > +/userdocs/forms/ajax.html > +/userdocs/forms/formlibraries.html > +/userdocs/forms/improving_sample.html > +/userdocs/forms/selectionlists.html > +/userdocs/forms/templating.html > +/userdocs/forms/widget_class.html > +/userdocs/forms/widget_form.html > +/userdocs/forms/widget_group.html > +/userdocs/forms/widget_imagemap.html > +/userdocs/forms/widget_tree.html > +/userdocs/forms/widget_union.html > +/userdocs/forms/widgetstates.html > +/userdocs/forms/xmlbinding.html > +/userdocs/matchers/template-matcher.html New content > -/userdocs/generators/sessionattribute-generator.html > -/userdocs/transformers/jpath-transformer.html > -/userdocs/transformers/role-filter-transformer.html > -/userdocs/transformers/simple-form-instance-transformer.html > -/userdocs/transformers/simple-form-transformer.html I've recreated the pages, with hardly any info in it, for url-compatibility sake. There were already links to the apidocs for these classes. > +/userdocs/transformers/463.html > -/userdocs/transformers/i18n-transformer.html Fixed, 463 = i18n-transformer Thanks Vadi
Re: [DOCS] Building for release - update round 2
Vadim Gritsenko wrote: Results are encouraging - now diff between old URI space and new version is much smaller (attached as well) Note that there are several numbered docs in there - either mislabelled old docs or newly added docs, i have not checked. Note, somehow only the menu is up on forrest.zones, all linked pages are gone. I suspect this is due to the split in the navigation doc in Daisy and should be fixed when Ross adjusts the appropriate files in Forrest. Here are snippets of your diff that I want to comment on: > +/692.html > +/692.html > +/692.html I'm not sure where you found this one, because it doesn't show up on the forrest.zone set. In Daisy I used it to work around a little problem in the navigation doc: if a group contains only links to external pages, it doesn't open because there is no internal document to display. The content of this page is reflected in the forrest.zones set similar to the cocoon.apache.org set, with one exception: the "Links" section is not present in forrest.zones although it is present in Daisy. > -/catalog-test.html IIUC this is only present in the repository, but not on cocoon.apache.org and also not in Daisy. It is beyond me to grasp the value of this page, so AFAIC I won't put any effort into it to get it on the website. Again, this is toplevel, so that explains its absence as well. > -/changes.html This is so outdated (see http://cocoon.apache.org/changes.html) that I would be ashamed to put it up again. So it's missing from Daisy (also because it's toplevel) and therefore from forrest.zones. > +/developing/portal/authentication.html In the original site, this points to /developing/webapps/authentication.html. Although Daisy also refers to the same document, it is now available under two urls. No showstopper for me. > /developing/portal/coplets.html > +/developing/portal/coplets/cachinguricoplet.html > +/developing/portal/coplets/uricoplet.html The two pages below are extracted from the huge coplets.html file and put in separate pages to keep the info more readable. They can be reached through the menu see forrest.zones. There was an issue with an extra /portal/ in the url. I've fixed that. Only thing that remains are the samples: daisy export: /developing/portal/samples/forms.html + .../basket.html cocoon.apache.org: /developing/portal/forms.html + .../basket.html > +/developing/portal/layout_skins.html > +/developing/portal/wsrp.html New content > +/developing/webapps/604.html Fixed > +/developing/webapps/application_management.html > +/developing/webapps/authenticating_user.html > +/developing/webapps/module_management.html > +/developing/webapps/pipeline_patterns.html > +/developing/webapps/summary.html > +/developing/webapps/user_administration.html > +/developing/webapps/user_management.html Same as for the portal: this was all part of one huge "authentication.html" file. I've split it into different smaller files to keep it more readable. They are all in the menu. > -/installing/requirements.html Fixed > -/plan/changes-doc.html > -/plan/issues-doc.html > -/plan/review-sitemap-docs.html > -/plan/todo-doc.html These are very old and very outdated. The info is either done or not valid any more. When we want to have a "hip and modern" Cocoon, these pages provide the opposite signal. Since they deal with documentation only, I suggest to simply leave them out. If people think the information is worthwhile keeping, I suggest we either move them to Daisy but only for archiving purposes, or we move the info to the wiki. > -/todo.html IIUC this is genererated from status.xml, so I didn't do anything with this, although I think this is a good candidate for either Jira (most obvious place) or a Daisy document (easier to get an overview). > +/userdocs/forms/ajax.html > +/userdocs/forms/formlibraries.html > +/userdocs/forms/improving_sample.html > +/userdocs/forms/selectionlists.html > +/userdocs/forms/templating.html > +/userdocs/forms/widget_class.html > +/userdocs/forms/widget_form.html > +/userdocs/forms/widget_group.html > +/userdocs/forms/widget_imagemap.html > +/userdocs/forms/widget_tree.html > +/userdocs/forms/widget_union.html > +/userdocs/forms/widgetstates.html > +/userdocs/forms/xmlbinding.html > +/userdocs/matchers/template-matcher.html New content > -/userdocs/generators/sessionattribute-generator.html > -/userdocs/transformers/jpath-transformer.html > -/userdocs/transformers/role-filter-transformer.html > -/userdocs/transformers/simple-form-instance-transformer.html > -/userdocs/transformers/simple-form-transformer.html I've recreated the pages, with hardly any info in it, for url-compatibility sake. There were already links to the apidocs for these classes. > +/userdocs/transformers/463.html > -/userdocs/transformers/i18n-transformer.html Fixed, 463 = i18n-transformer Bye, Helma
