You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by David Crossley <cr...@apache.org> on 2005/03/16 23:25:08 UTC
merging separate sets of generated docs, default tabs (Was: svn commit: r157791)
This was deliberate. We will eventually need to find a better way
to link separate sets of documentation. Apache Cocoon has this
same issue.
The full URLs is not a proper solution. Apache websites need to be
able to be mirrored. For example, this coming weekend all Apache
websites are going to fail-over to eu.apache.org while infrastructure
work is being done.
--David
> Author: brondsem
> Date: Wed Mar 16 11:27:36 2005
> New Revision: 157791
>
> URL: http://svn.apache.org/viewcvs?view=rev&rev=157791
> Log:
> these tab links were breaking; point to the full url of the files created from docs-author
>
> Modified:
> forrest/trunk/site-author/content/xdocs/tabs.xml
>
> Modified: forrest/trunk/site-author/content/xdocs/tabs.xml
> URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tabs.xml?view=diff&r1=157790&r2=157791
> ==============================================================================
> --- forrest/trunk/site-author/content/xdocs/tabs.xml (original)
> +++ forrest/trunk/site-author/content/xdocs/tabs.xml Wed Mar 16 11:27:36 2005
> @@ -35,7 +35,7 @@
>
> <tab id="home" label="Welcome" dir=""/>
> <tab id="project" label="Project" dir="" indexfile="contrib.html"/>
> - <tab id="docs" label="Documentation" dir="docs/"/>
> - <tab id="howto" label="How-To" dir="howto/"/>
> + <tab id="docs" label="Documentation" href="http://forrest.apache.org/docs"/><!-- change to /docs/0.7 after we make the 0.7 release and get rid of 0.6 doc structure -->
> + <tab id="howto" label="How-To" href="http://forrest.apache.org/howto"/><!-- change to /docs/0.7/howto -->
>
> </tabs>
-------------------------
Author: brondsem
Date: Wed Mar 16 09:46:03 2005
New Revision: 157779
URL: http://svn.apache.org/viewcvs?view=rev&rev=157779
Log:
documentation stands alone, not integrated with the project site
Modified:
forrest/trunk/docs-author/content/xdocs/tabs.xml
Modified: forrest/trunk/docs-author/content/xdocs/tabs.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/tabs.xml?view=diff&r1=157778&r2=157779
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/tabs.xml (original)
+++ forrest/trunk/docs-author/content/xdocs/tabs.xml Wed Mar 16 09:46:03 2005
@@ -36,8 +36,6 @@
<!-- FIXME: FOR-447
<tab id="home" label="Welcome" dir="../../"/>
-->
- <tab id="home" label="Welcome" dir="" indexfile="../../mail-lists.html"/>
- <tab id="project" label="Project" dir="" indexfile="../../contrib.html"/>
<tab id="docs" label="0.7-dev Documentation" dir="/" indexfile="index.html">
<tab id="core" label="Core" indexfile="your-project.html"/>
<tab id="forrestbor" label="ForrestBot" indexfile="forrestbot.html"/>
Re: merging separate sets of generated docs, default tabs (Was: svn commit: r157791)
Posted by David Crossley <cr...@apache.org>.
Reinhard Poetz wrote:
> David Crossley wrote:
> >This was deliberate. We will eventually need to find a better way
> >to link separate sets of documentation. Apache Cocoon has this
> >same issue.
>
> Yes, this is a maintenance nightmare ATM. Any improvment here would be
> hightly appreciated!
So would suggestions. As you know from Cocoon, it is difficult to
maintain documentation in separate repositories that get merged
to form the website, yet still work properly offline.
You have been solving some code issues using "svn:externals".
I wonder if that approach might help with documentation too.
I cannot see how, but maybe you can.
At both projects we have 3 separate sets of docs.
Cocoon has even more, with a set for each block.
"site" docs i.e. top-level.
"docs" related to the current release version.
"docs/dev" related to the current development version.
--David
Re: merging separate sets of generated docs, default tabs (Was: svn
commit: r157791)
Posted by Reinhard Poetz <re...@apache.org>.
David Crossley wrote:
> This was deliberate. We will eventually need to find a better way
> to link separate sets of documentation. Apache Cocoon has this
> same issue.
Yes, this is a maintenance nightmare ATM. Any improvment here would be hightly
appreciated!
--
Reinhard Pötz Independant Consultant, Trainer & (IT)-Coach
{Software Engineering, Open Source, Web Applications, Apache Cocoon}
web(log): http://www.poetz.cc
--------------------------------------------------------------------
Re: merging separate sets of generated docs, default tabs (Was: svn
commit: r157791)
Posted by Reinhard Poetz <re...@apache.org>.
David Crossley wrote:
> This was deliberate. We will eventually need to find a better way
> to link separate sets of documentation. Apache Cocoon has this
> same issue.
Yes, this is currently a maintenance nightmare ATM. Any improvment here would be
hightly appreciated!
--
Reinhard Pötz Independant Consultant, Trainer & (IT)-Coach
{Software Engineering, Open Source, Web Applications, Apache Cocoon}
web(log): http://www.poetz.cc
--------------------------------------------------------------------
Re: merging separate sets of generated docs, default tabs
Posted by Dave Brondsema <da...@brondsema.net>.
David Crossley wrote:
> Dave Brondsema wrote:
>
>>Ok. What about href="/docs"? I think because it is a 'href' it would
>>keep it from failing the build, and it would still be relative.
>
>
> That should work. I woder why we didn't think of that before.
> Maybe it was all getting confused with the separate 0.6 docs.
> Dunno. Lets try it.
>
>
Done. I had forgotten about this.
>>Regarding the 2nd change: I removed the project-related tabs from
>>docs-author, so that the docs would be completely independent. This
>>lets a user have a local copy of the docs with no broken links; it is
>>also like the way the httpd docs are. Any problem with this?
>
>
> When the docs are on the website, how will we navigate back to the
> Project and Welcome information if there are no tabs.
>
The breadcrumbs and logo link back to the main site, although that may
not be obvious. http://httpd.apache.org/docs-2.0/ only has breadcrumbs;
I think it is okay.
> --David
>
>
>>David Crossley wrote:
>>
>>>This was deliberate. We will eventually need to find a better way
>>>to link separate sets of documentation. Apache Cocoon has this
>>>same issue.
>>>
>>>The full URLs is not a proper solution. Apache websites need to be
>>>able to be mirrored. For example, this coming weekend all Apache
>>>websites are going to fail-over to eu.apache.org while infrastructure
>>>work is being done.
>>>
>>>--David
>>>
>>>
>>>
>>>>Author: brondsem
>>>>Date: Wed Mar 16 11:27:36 2005
>>>>New Revision: 157791
>>>>
>>>>URL: http://svn.apache.org/viewcvs?view=rev&rev=157791
>>>>Log:
>>>>these tab links were breaking; point to the full url of the files created
>>>
>>>>from docs-author
>>>
>>>>Modified:
>>>> forrest/trunk/site-author/content/xdocs/tabs.xml
>>>>
>>>>Modified: forrest/trunk/site-author/content/xdocs/tabs.xml
>>>>URL:
>>>>http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tabs.xml?view=diff&r1=157790&r2=157791
>>>>==============================================================================
>>>>--- forrest/trunk/site-author/content/xdocs/tabs.xml (original)
>>>>+++ forrest/trunk/site-author/content/xdocs/tabs.xml Wed Mar 16 11:27:36
>>>>2005
>>>>@@ -35,7 +35,7 @@
>>>>
>>>> <tab id="home" label="Welcome" dir=""/>
>>>> <tab id="project" label="Project" dir="" indexfile="contrib.html"/>
>>>>- <tab id="docs" label="Documentation" dir="docs/"/>
>>>>- <tab id="howto" label="How-To" dir="howto/"/>
>>>>+ <tab id="docs" label="Documentation"
>>>>href="http://forrest.apache.org/docs"/><!-- change to /docs/0.7 after we
>>>>make the 0.7 release and get rid of 0.6 doc structure -->
>>>>+ <tab id="howto" label="How-To"
>>>>href="http://forrest.apache.org/howto"/><!-- change to /docs/0.7/howto -->
>>>>
>>>></tabs>
>>>
>>>
>>>-------------------------
>>>
>>>Author: brondsem
>>>Date: Wed Mar 16 09:46:03 2005
>>>New Revision: 157779
>>>
>>>URL: http://svn.apache.org/viewcvs?view=rev&rev=157779
>>>Log:
>>>documentation stands alone, not integrated with the project site
>>>
>>>Modified:
>>> forrest/trunk/docs-author/content/xdocs/tabs.xml
>>>
>>>Modified: forrest/trunk/docs-author/content/xdocs/tabs.xml
>>>URL:
>>>http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/tabs.xml?view=diff&r1=157778&r2=157779
>>>==============================================================================
>>>--- forrest/trunk/docs-author/content/xdocs/tabs.xml (original)
>>>+++ forrest/trunk/docs-author/content/xdocs/tabs.xml Wed Mar 16 09:46:03
>>>2005
>>>@@ -36,8 +36,6 @@
>>><!-- FIXME: FOR-447
>>> <tab id="home" label="Welcome" dir="../../"/>
>>>-->
>>>- <tab id="home" label="Welcome" dir=""
>>>indexfile="../../mail-lists.html"/>
>>>- <tab id="project" label="Project" dir=""
>>>indexfile="../../contrib.html"/>
>>> <tab id="docs" label="0.7-dev Documentation" dir="/"
>>> indexfile="index.html">
>>> <tab id="core" label="Core" indexfile="your-project.html"/>
>>> <tab id="forrestbor" label="ForrestBot"
>>> indexfile="forrestbot.html"/>
>
>
--
Dave Brondsema : dave@brondsema.net
http://www.splike.com : programming
http://csx.calvin.edu : student org
http://www.brondsema.net : personal
Re: merging separate sets of generated docs, default tabs
Posted by David Crossley <cr...@apache.org>.
Dave Brondsema wrote:
>
> Ok. What about href="/docs"? I think because it is a 'href' it would
> keep it from failing the build, and it would still be relative.
That should work. I woder why we didn't think of that before.
Maybe it was all getting confused with the separate 0.6 docs.
Dunno. Lets try it.
> Regarding the 2nd change: I removed the project-related tabs from
> docs-author, so that the docs would be completely independent. This
> lets a user have a local copy of the docs with no broken links; it is
> also like the way the httpd docs are. Any problem with this?
When the docs are on the website, how will we navigate back to the
Project and Welcome information if there are no tabs.
--David
> David Crossley wrote:
> >This was deliberate. We will eventually need to find a better way
> >to link separate sets of documentation. Apache Cocoon has this
> >same issue.
> >
> >The full URLs is not a proper solution. Apache websites need to be
> >able to be mirrored. For example, this coming weekend all Apache
> >websites are going to fail-over to eu.apache.org while infrastructure
> >work is being done.
> >
> >--David
> >
> >
> >>Author: brondsem
> >>Date: Wed Mar 16 11:27:36 2005
> >>New Revision: 157791
> >>
> >>URL: http://svn.apache.org/viewcvs?view=rev&rev=157791
> >>Log:
> >>these tab links were breaking; point to the full url of the files created
> >>from docs-author
> >>
> >>Modified:
> >> forrest/trunk/site-author/content/xdocs/tabs.xml
> >>
> >>Modified: forrest/trunk/site-author/content/xdocs/tabs.xml
> >>URL:
> >>http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tabs.xml?view=diff&r1=157790&r2=157791
> >>==============================================================================
> >>--- forrest/trunk/site-author/content/xdocs/tabs.xml (original)
> >>+++ forrest/trunk/site-author/content/xdocs/tabs.xml Wed Mar 16 11:27:36
> >>2005
> >>@@ -35,7 +35,7 @@
> >>
> >> <tab id="home" label="Welcome" dir=""/>
> >> <tab id="project" label="Project" dir="" indexfile="contrib.html"/>
> >>- <tab id="docs" label="Documentation" dir="docs/"/>
> >>- <tab id="howto" label="How-To" dir="howto/"/>
> >>+ <tab id="docs" label="Documentation"
> >>href="http://forrest.apache.org/docs"/><!-- change to /docs/0.7 after we
> >>make the 0.7 release and get rid of 0.6 doc structure -->
> >>+ <tab id="howto" label="How-To"
> >>href="http://forrest.apache.org/howto"/><!-- change to /docs/0.7/howto -->
> >>
> >></tabs>
> >
> >
> >-------------------------
> >
> >Author: brondsem
> >Date: Wed Mar 16 09:46:03 2005
> >New Revision: 157779
> >
> >URL: http://svn.apache.org/viewcvs?view=rev&rev=157779
> >Log:
> >documentation stands alone, not integrated with the project site
> >
> >Modified:
> > forrest/trunk/docs-author/content/xdocs/tabs.xml
> >
> >Modified: forrest/trunk/docs-author/content/xdocs/tabs.xml
> >URL:
> >http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/tabs.xml?view=diff&r1=157778&r2=157779
> >==============================================================================
> >--- forrest/trunk/docs-author/content/xdocs/tabs.xml (original)
> >+++ forrest/trunk/docs-author/content/xdocs/tabs.xml Wed Mar 16 09:46:03
> >2005
> >@@ -36,8 +36,6 @@
> > <!-- FIXME: FOR-447
> > <tab id="home" label="Welcome" dir="../../"/>
> > -->
> >- <tab id="home" label="Welcome" dir=""
> >indexfile="../../mail-lists.html"/>
> >- <tab id="project" label="Project" dir=""
> >indexfile="../../contrib.html"/>
> > <tab id="docs" label="0.7-dev Documentation" dir="/"
> > indexfile="index.html">
> > <tab id="core" label="Core" indexfile="your-project.html"/>
> > <tab id="forrestbor" label="ForrestBot"
> > indexfile="forrestbot.html"/>
Re: merging separate sets of generated docs, default tabs (Was: svn
commit: r157791)
Posted by Dave Brondsema <da...@brondsema.net>.
Ok. What about href="/docs"? I think because it is a 'href' it would
keep it from failing the build, and it would still be relative.
Regarding the 2nd change: I removed the project-related tabs from
docs-author, so that the docs would be completely independent. This
lets a user have a local copy of the docs with no broken links; it is
also like the way the httpd docs are. Any problem with this?
David Crossley wrote:
> This was deliberate. We will eventually need to find a better way
> to link separate sets of documentation. Apache Cocoon has this
> same issue.
>
> The full URLs is not a proper solution. Apache websites need to be
> able to be mirrored. For example, this coming weekend all Apache
> websites are going to fail-over to eu.apache.org while infrastructure
> work is being done.
>
> --David
>
>
>>Author: brondsem
>>Date: Wed Mar 16 11:27:36 2005
>>New Revision: 157791
>>
>>URL: http://svn.apache.org/viewcvs?view=rev&rev=157791
>>Log:
>>these tab links were breaking; point to the full url of the files created from docs-author
>>
>>Modified:
>> forrest/trunk/site-author/content/xdocs/tabs.xml
>>
>>Modified: forrest/trunk/site-author/content/xdocs/tabs.xml
>>URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tabs.xml?view=diff&r1=157790&r2=157791
>>==============================================================================
>>--- forrest/trunk/site-author/content/xdocs/tabs.xml (original)
>>+++ forrest/trunk/site-author/content/xdocs/tabs.xml Wed Mar 16 11:27:36 2005
>>@@ -35,7 +35,7 @@
>>
>> <tab id="home" label="Welcome" dir=""/>
>> <tab id="project" label="Project" dir="" indexfile="contrib.html"/>
>>- <tab id="docs" label="Documentation" dir="docs/"/>
>>- <tab id="howto" label="How-To" dir="howto/"/>
>>+ <tab id="docs" label="Documentation" href="http://forrest.apache.org/docs"/><!-- change to /docs/0.7 after we make the 0.7 release and get rid of 0.6 doc structure -->
>>+ <tab id="howto" label="How-To" href="http://forrest.apache.org/howto"/><!-- change to /docs/0.7/howto -->
>>
>> </tabs>
>
>
> -------------------------
>
> Author: brondsem
> Date: Wed Mar 16 09:46:03 2005
> New Revision: 157779
>
> URL: http://svn.apache.org/viewcvs?view=rev&rev=157779
> Log:
> documentation stands alone, not integrated with the project site
>
> Modified:
> forrest/trunk/docs-author/content/xdocs/tabs.xml
>
> Modified: forrest/trunk/docs-author/content/xdocs/tabs.xml
> URL: http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/tabs.xml?view=diff&r1=157778&r2=157779
> ==============================================================================
> --- forrest/trunk/docs-author/content/xdocs/tabs.xml (original)
> +++ forrest/trunk/docs-author/content/xdocs/tabs.xml Wed Mar 16 09:46:03 2005
> @@ -36,8 +36,6 @@
> <!-- FIXME: FOR-447
> <tab id="home" label="Welcome" dir="../../"/>
> -->
> - <tab id="home" label="Welcome" dir="" indexfile="../../mail-lists.html"/>
> - <tab id="project" label="Project" dir="" indexfile="../../contrib.html"/>
> <tab id="docs" label="0.7-dev Documentation" dir="/" indexfile="index.html">
> <tab id="core" label="Core" indexfile="your-project.html"/>
> <tab id="forrestbor" label="ForrestBot" indexfile="forrestbot.html"/>
>
>
--
Dave Brondsema : dave@brondsema.net
http://www.splike.com : programming
http://csx.calvin.edu : student org
http://www.brondsema.net : personal