[Geoserver-devel] User Manual restructured at code sprint

Hi all. I'm taking part in the recent Wicket 7 code sprint [1], but waiting for something to test gave me some time to do a (IMO badly needed) restructuring of the User Manual.

Here are the highlights, pasted from the PR [2]:

"""
* Front page replaced with section headers and short descriptions. Most other index pages have been compacted. No more giant walls of TOC.

* The elaborate web admin section has been removed. Pages that were contained there have been migrated to each relevant reference section (for example: there's now a section on the security UI pages in the "Security" section). Grouping by functionality will lead to less duplication of content and make it easier for users to find information. The one main page on the web admin that remains links to all relevant sections, so users who prefer the old way of finding content will continue be able to do so.

* New "Server configuration" section comprising relevant content pulled from other areas.

* "Google Earth" section is now part of WMS and is no longer listed on the front page.

Screenshots and other content were not altered.
"""

There are a lot of changes here, but as I haven't had much time to devote to GeoServer docs recently, this was a chance for me to catch up. Still lots more work to be done (this wasn't a content update, just a restructuring), but hopefully this will make things easier for our users as well as for those who update our documentation going forward.

(Also, as a fun fact, I found some screenshots from GeoServer 1.x still hidden in our code [3]. Still!)

This work will be merged in to master along with all the other work completed at this code sprint.

And of course, hopefully these changes jive with people. As always, please let me know if you have questions.

[1] https://wiki.osgeo.org/wiki/GeoServer_Code_Sprint_2016
[2] https://github.com/geoserver/geoserver/pull/1439
[3] https://github.com/geoserver/geoserver/blob/master/doc/en/user/source/gettingstarted/web-admin-quickstart/map-preview.png

Thanks,
Mike

Mike Pumphrey
User Advocate | Boundless
917-338-0407
mike@anonymised.com
http://boundlessgeo.com
@boundlessgeo

Thanks Mike, looking forward to it.

In the same fashion I have been cleaning up some of the screens and making them easier to use - doing things like moving the email field to the top of the contact info page (and removing the duplicate email field)

···

On 21 January 2016 at 16:25, Mike Pumphrey <mike@anonymised.com> wrote:

Hi all. I’m taking part in the recent Wicket 7 code sprint [1], but waiting for something to test gave me some time to do a (IMO badly needed) restructuring of the User Manual.

Here are the highlights, pasted from the PR [2]:

“”"

  • Front page replaced with section headers and short descriptions. Most other index pages have been compacted. No more giant walls of TOC.

  • The elaborate web admin section has been removed. Pages that were contained there have been migrated to each relevant reference section (for example: there’s now a section on the security UI pages in the “Security” section). Grouping by functionality will lead to less duplication of content and make it easier for users to find information. The one main page on the web admin that remains links to all relevant sections, so users who prefer the old way of finding content will continue be able to do so.

  • New “Server configuration” section comprising relevant content pulled from other areas.

  • “Google Earth” section is now part of WMS and is no longer listed on the front page.

Screenshots and other content were not altered.
“”"

There are a lot of changes here, but as I haven’t had much time to devote to GeoServer docs recently, this was a chance for me to catch up. Still lots more work to be done (this wasn’t a content update, just a restructuring), but hopefully this will make things easier for our users as well as for those who update our documentation going forward.

(Also, as a fun fact, I found some screenshots from GeoServer 1.x still hidden in our code [3]. Still!)

This work will be merged in to master along with all the other work completed at this code sprint.

And of course, hopefully these changes jive with people. As always, please let me know if you have questions.

[1] https://wiki.osgeo.org/wiki/GeoServer_Code_Sprint_2016
[2] https://github.com/geoserver/geoserver/pull/1439
[3] https://github.com/geoserver/geoserver/blob/master/doc/en/user/source/gettingstarted/web-admin-quickstart/map-preview.png

Thanks,
Mike

Mike Pumphrey
User Advocate | Boundless
917-338-0407
mike@anonymised.com
http://boundlessgeo.com
@boundlessgeo


Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=267308311&iu=/4140


Geoserver-devel mailing list
Geoserver-devel@anonymised.comsts.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel


Jody Garnett