Moving ahead with the switch to the new documentation, one next step is to deprecate the docs in the wiki. This will ensure that people will know what is (hopefully) current and what isn't.
The pages in question are those in the GEOSDOC space [1]. This includes the current User Guide and Developer Guide. Other pages, such as the homepage and anything in the GEOS space [2] will be unaffected.
So how to do this? Apparently, Confluence isn't excellent at theming just a single space. I was thinking that adding a warning box to the top of each page with a message pointing in the right direction might be a better way to go. If so, maybe (fingers crossed), it might be possible to script insert some Wiki Markup to the head of each page, via the database. Arne, do you know if such a think would be possible?
Some examples of what I was thinking are here [3]. Please feel free to comment. What would you like to see that is intrusive enough to be noticed, but not intrusive enough to be irritating?
So how to do this? Apparently, Confluence isn't excellent at theming just a single space.
You can set a template for just a single space.
Question for you: are we still leaving the wiki available for the user
community (to serve as unofficial) documentation? If so we can set up
this link to "official docummentation" on each page.
So how to do this? Apparently, Confluence isn't excellent at theming just a single space.
You can set a template for just a single space.
Question for you: are we still leaving the wiki available for the user
community (to serve as unofficial) documentation? If so we can set up
this link to "official docummentation" on each page.
The plan (as I know it) is to keep the wiki for things that are appropriate for a wiki. R&D pages, proposals, road maps, etc...
And just making the sphinx docs the official user and developer guides.
Jody
------------------------------------------------------------------------------
This SF.net email is sponsored by:
High Quality Requirements in a Collaborative Environment.
Download a free trial of Rational Requirements Composer Now! http://p.sf.net/sfu/www-ibm-com
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geoserver-devel
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
Hi Jody. Yes, the wiki is not going to "go away" (like GEOSDEV did), but I want to make sure to start pointing people in the right direction so as to minimize confusion. Although the details haven't been hammered out, the wiki will turn into unofficial (or community) documentation. If a document is deemed high quality, it can be absorbed into the official docs (the ones that are included with releases, etc).
Can you set a template for a single space for already existing pages? I thought Confluence templates were just for creating new pages.
So how to do this? Apparently, Confluence isn't excellent at theming just a single space.
You can set a template for just a single space.
Question for you: are we still leaving the wiki available for the user
community (to serve as unofficial) documentation? If so we can set up
this link to "official docummentation" on each page.
Can you set a template for a single space for already existing pages? I
thought Confluence templates were just for creating new pages.
Sorry used the wrong word - confluence templates are single use as you
say (only for creation).
Confluence layouts however can be customized (and you can do custom
html etc); I would adjust the layout to link to the official docs;
indeed it would be nice to make the link a google "I am feeling link"
based on the title of the page; restricted to the documentation site.
So how to do this? Apparently, Confluence isn't excellent at theming
just a single space.
You can set a template for just a single space.
Question for you: are we still leaving the wiki available for the user
community (to serve as unofficial) documentation? If so we can set up
this link to "official docummentation" on each page.
Can you set a template for a single space for already existing pages? I
thought Confluence templates were just for creating new pages.
Sorry used the wrong word - confluence templates are single use as you
say (only for creation).
Confluence layouts however can be customized (and you can do custom
html etc); I would adjust the layout to link to the official docs;
indeed it would be nice to make the link a google "I am feeling link"
based on the title of the page; restricted to the documentation site.
So how to do this? Apparently, Confluence isn't excellent at theming
just a single space.
You can set a template for just a single space.
Question for you: are we still leaving the wiki available for the user
community (to serve as unofficial) documentation? If so we can set up
this link to "official docummentation" on each page.
What does this mean for us? Are we back to hacking the theme (which I don't
believe is space specific) or is there another way?
We are back to hacking the theme; you can do that on a space by space
basis using the global theme as a starting point.
indeed it would be nice to make the link a google "I am feeling link"
based on the title of the page; restricted to the documentation site.
Sorry, I'm not sure what you mean here.
When you say the document has moved; provide a link to the new page
(or ask google to hunt down a page in the new documentation based on
the title of the current page).
I briefly peeked into the database, it looks doable if the caches arent too tricky. But I think Jody is right, creating a new theme seems like a cleaner solution.
We could also use Google Analytics to figure out what the 50 most important pages are, and then redirect as appropriate. That way we also transfer some pagerank.
-Arne
Mike Pumphrey wrote:
From the Leading-The-Horse-To-Water Dept:*
Moving ahead with the switch to the new documentation, one next step is to deprecate the docs in the wiki. This will ensure that people will know what is (hopefully) current and what isn't.
The pages in question are those in the GEOSDOC space [1]. This includes the current User Guide and Developer Guide. Other pages, such as the homepage and anything in the GEOS space [2] will be unaffected.
So how to do this? Apparently, Confluence isn't excellent at theming just a single space. I was thinking that adding a warning box to the top of each page with a message pointing in the right direction might be a better way to go. If so, maybe (fingers crossed), it might be possible to script insert some Wiki Markup to the head of each page, via the database. Arne, do you know if such a think would be possible?
Some examples of what I was thinking are here [3]. Please feel free to comment. What would you like to see that is intrusive enough to be noticed, but not intrusive enough to be irritating?
This is what we've come up with for now. It looks like Chris Patterson has cracked the code on theming just one space, so changes can presumably be made if need be.
Moving ahead with the switch to the new documentation, one next step is to deprecate the docs in the wiki. This will ensure that people will know what is (hopefully) current and what isn't.
The pages in question are those in the GEOSDOC space [1]. This includes the current User Guide and Developer Guide. Other pages, such as the homepage and anything in the GEOS space [2] will be unaffected.
So how to do this? Apparently, Confluence isn't excellent at theming just a single space. I was thinking that adding a warning box to the top of each page with a message pointing in the right direction might be a better way to go. If so, maybe (fingers crossed), it might be possible to script insert some Wiki Markup to the head of each page, via the database. Arne, do you know if such a think would be possible?
Some examples of what I was thinking are here [3]. Please feel free to comment. What would you like to see that is intrusive enough to be noticed, but not intrusive enough to be irritating?
------------------------------------------------------------------------------
This SF.net email is sponsored by:
High Quality Requirements in a Collaborative Environment.
Download a free trial of Rational Requirements Composer Now! http://p.sf.net/sfu/www-ibm-com
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geoserver-devel
