12373 grid config

[joshmoore]

I recently asked @kennethgillen to take a glance at the properties in etc/omero.properties for readability etc. This PR is probably as good a place as any for suggestions for improvement. This may also go along with the recent discussion under ome/omero-documentation#826

• 12373 - fix urls

[manics]

👍 to not manually copying (ome/omero-documentation#826 (comment))

However, is there any real value in automatically copying things, as opposed to just linking directly to the source properties files/lines? E.g. Using Apache as an example, httpd.conf contains a brief explanation of each option, the online docs are much more thorough and provide more background info http://httpd.apache.org/docs/2.2/configuring.html

Or do the opposite- extensive documentation within the config files, and just highlight the most important ones in Sphinx.

[manics]

This file can and should not be modified. ???

[mtbc]

sounds rather like "must" doesn't it (-:

[joshmoore]

Is ae4bae5 clearer? 😄

[manics]

Are you planning to remove all trac links? Some work, some redirect to the docs home page e.g. http://trac.openmicroscopy.org.uk/ome/wiki/OmeroSearch

[joshmoore]

re: trac links -- will do, @manics, ta.

[sbesson]

Seconding @manics on his comment. My personal preference would be to have extensive documentation in the ome-documentation repository and minimal documentation with hyperlinks in the config file itself. Auto-generation is pretty limited in this case in my opinion as we will need to manually edit the content to be auto-generated anyways (as opposed to e.g. metadata format pages in Bio-Formats).

If we are going that route, in terms of design, I think we should match the organization of the omero.properties with the sysadmin documentation is organized, i.e.

• either have a global properties page with a glossary of all properties
• or split by sections (as we semi-do now) where the properties are described and have sections of omero.properties matching sections of the documentation. This is my preference as well.

[joshmoore]

I replaced the other trac URLs & pushed. I'd say we should probably end this here and wait for the auto-memory (gh-2595) and event-log-queue (gh-2639) PRs to go through, otherwise there will be endless conflicts.

[sbesson]

Why ?highlight=grid?

[joshmoore]

I always like the highlighting, and it shows what to search for in our side box. But happy to remove those.

[manics]

I think highlighting works when a term is mentioned rarely in a page, but in this case the whole page is relevant.

[manics]

http://quartz.sourceforge.net appears to be dead

[joshmoore]

Pushed.

[manics]

👍

[sbesson]

@joshmoore: any additional change planned?

[joshmoore]

Nope. Bigger changes need to wait for my other 2 PRs to be merged or excluded.

[joshmoore]

--rebased-to #2680