Okay I am having computer difficulties; and I see Mauricio is already going
for it; so rather than hold things up it is time to open up the gates. I am
going to hang out as module maintainer for "doc" incase anyone needs a
review (or is having trouble with sphinx).
Jody
On Mon, Apr 18, 2011 at 1:28 PM, Jody Garnett <jody.garn...@gmail.com>wrote:
> One interesting challenge would be to sort out the summary information on
> the "module matrix" page and bring it into the docs; as far as I know sphinx
> does not have a cute little start symbol.
>
> But it would be nice to have a section on each index page that covered the
> same information as the module matrix ...
>
> 1. Gold Star rating
> 2. Link to Jira issues
> 3. Legal Status (currently this links to a maven site page; and we don't
> build the maven site information anymore)
> 3. Module Maintainer
> 4. Contact details (usually just the user list)
> (5. commercial support?)
>
> The other half of the module matrix page seems to be any special build
> instructions; that could go into "internal" as it does not relate to use.
>
> I may try mocking this up and see if we can get something reasonable...
>
> Jody
>
> On Mon, Apr 18, 2011 at 12:41 PM, Michael Bedward <
> michael.bedw...@gmail.com> wrote:
>
>> Hello Jody,
>>
>> +1 from me for both the structure and your editing rules.
>>
>> I did some minor edits yesterday (vector grids page) that still seem
>> to be there but will hold off on any more editing until you give the
>> word.
>>
>> As an aside, I've been reading a little about creating custom sphinx
>> directives, trying to work out how hard it would be to do a smarter
>> literalinclude which would allow the use of substitutions (if that's
>> the right term) in the path.
>>
>> Michael
>>
>> On 18 April 2011 11:25, Jody Garnett <jody.garn...@gmail.com> wrote:
>> > Currently I am exporting out the docs from a word munching program; this
>> > allows me to easily change the structure quickly.
>> > Can I ask people to review the current structure of the docs; and ask
>> for
>> > any changes they need now; then I can open up the doc module to more
>> general
>> > contribution and fixing.
>> > IF YOU HAVE ALREADY CONTRIBUTED
>> > I have been trying to check if others are writing into the doc; but
>> there is
>> > a chance I will just overwrite your work at the moment; please email me
>> with
>> > doc changes.
>> > Can you take a moment to check for your writing to see if we need to
>> recover
>> > it from svn?
>> > FOR CONTRIBUTING TO THE DOC
>> > I do have a couple of ground rules for the docs.
>> > 1. do not use cross references
>> > NO: .. _feature_tutorial: followed by :ref:`feature_tutorial`
>> > YES: :doc:`/tutorials/quickstart.eclipse`
>> > 2. Use doc references
>> > :doc:`gt-main </library/main/index>`
>> > :doc:`gt-main feature implementation </library/main/feature>`
>> > 3. Reference images and source code relative to the root of the document
>> > (this allows text to be moved around quickly without fear of breaking
>> > links).
>> >
>> > .. image:: /images/SimpleFeatureSource.PNG
>> >
>> > .. literalinclude::
>> > /../src/main/java/org/geotools/data/SimpleFeatureStoreExamples.java
>> > :language: java
>> > :start-after: // removeExample start
>> > :end-before: // removeExample end
>> > 4. Finally you may (or may not be surprised) that all the code examples
>> are
>> > not live.
>> > For each module I have tried to have one XXXExample.java file; with an
>> > example of how "literalinclude" works. The idea being that the code
>> > examples can gradually become real as you have a chance to work on them.
>> > 5. Structure
>> > http://docs.geotools.org/latest/userguide/library/jdbc/index.html
>> > Each section has an "index.txt" page that includes the others
>> > There is an svg picture showing where people are; the svg is in
>> version
>> > control if you need to update it.
>> > http://docs.geotools.org/latest/userguide/library/jdbc/internal.html
>> > Each section has an "internal.txt" or a complete folder
>> > "internal/index.txt" that contains all the design details and other
>> > stuff that is not directly concerned with *use*
>> > http://docs.geotools.org/latest/userguide/library/jdbc/faq.html
>> > Each section has a "faq.txt" which is included in the root "faq.txt"
>> > allowing users to have a "question based lookup".
>> > http://docs.geotools.org/latest/userguide/extension/validation.html
>> > http://docs.geotools.org/latest/userguide/library/opengis/model.html
>> > Each page can have a "References" list linking to related stuff;
>> please
>> > try and do this after the initial intro paragraph to avoid
>> > sprinkling links all over the place in your text and getting off
>> topic.
>> > And yes I need to write this into the developers guide (to replace the
>> > existing wiki writing guidelines)
>> > --
>> > Jody Garnett
>> >
>> >
>> >
>> ------------------------------------------------------------------------------
>> > Benefiting from Server Virtualization: Beyond Initial Workload
>> > Consolidation -- Increasing the use of server virtualization is a top
>> > priority.Virtualization can reduce costs, simplify management, and
>> improve
>> > application availability and disaster protection. Learn more about
>> boosting
>> > the value of server virtualization.
>> http://p.sf.net/sfu/vmware-sfdev2dev
>> > _______________________________________________
>> > Geotools-devel mailing list
>> > Geotools-devel@lists.sourceforge.net
>> > https://lists.sourceforge.net/lists/listinfo/geotools-devel
>> >
>> >
>>
>
>
------------------------------------------------------------------------------
Benefiting from Server Virtualization: Beyond Initial Workload
Consolidation -- Increasing the use of server virtualization is a top
priority.Virtualization can reduce costs, simplify management, and improve
application availability and disaster protection. Learn more about boosting
the value of server virtualization. http://p.sf.net/sfu/vmware-sfdev2dev
_______________________________________________
Geotools-devel mailing list
Geotools-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geotools-devel
