GeoTools

correct module page to no longer refer to example folder

Details

  • Type: Sub-task Sub-task
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: admin, docs
  • Labels:
    None

Description

The module page attempts to outline "normal" maven directory structure; and give an overview of how our modules are arranged in a checkout.

A couple small fixed:

  • demo - no longer used (and has been added)
  • ogc - added
  • docs - added
  • Removed reference to "Maven 2" standard layout (as we use maven 3 now)

I softened the words here to be "The modules are are organised according to their role (some examples are shown below):" hopefully allowing this page to not go stale so quickly.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Jody Garnett added a comment -
Ben can I ask you to read over the page:
- http://docs.geotools.org/latest/developer/guide/conventions/module.html

(yes I am assigning most review things to you; what can I say you are in my timezone)
Show
Jody Garnett added a comment - Ben can I ask you to read over the page: - http://docs.geotools.org/latest/developer/guide/conventions/module.html (yes I am assigning most review things to you; what can I say you are in my timezone)
Hide
Permalink
Ben Caradoc-Davies added a comment -
Jody, the URL is incorrect. The correct URL is:
http://docs.geotools.org/latest/developer/conventions/module.html

- Typo on the first line "lauout".

- The old conventions specified modules/category/module/src/main/resources/test-data for all test data, to prevent them being considered a Java package. I don't agree with this, but that was in the developer guide.

- "Shapefile" should be lowercase? (In modules/plugin section)

- You could mention app-schema as a modules/extensions. :-)

Other than that, looks good.
Show
Ben Caradoc-Davies added a comment - Jody, the URL is incorrect. The correct URL is: http://docs.geotools.org/latest/developer/conventions/module.html - Typo on the first line "lauout". - The old conventions specified modules/category/module/src/main/resources/test-data for all test data, to prevent them being considered a Java package. I don't agree with this, but that was in the developer guide. - "Shapefile" should be lowercase? (In modules/plugin section) - You could mention app-schema as a modules/extensions. :-) Other than that, looks good.
Hide
Permalink
Jody Garnett added a comment -
Thanks; I too out the /guide/ yesterday as it was not adding any value. Changes being applied now; thanks for the review.
Show
Jody Garnett added a comment - Thanks; I too out the /guide/ yesterday as it was not adding any value. Changes being applied now; thanks for the review.
Hide
Permalink
Jody Garnett added a comment -
Oh for the "test-data" thing that is actually a javadoc guidelines straight from sun; they use something similar for "doc-files" for javadocs; the idea is to make folders *not* packages.
Show
Jody Garnett added a comment - Oh for the "test-data" thing that is actually a javadoc guidelines straight from sun; they use something similar for "doc-files" for javadocs; the idea is to make folders *not* packages.
Hide
Permalink
Jody Garnett added a comment -
Thanks for the review; commit will go up shortly.
Show
Jody Garnett added a comment - Thanks for the review; commit will go up shortly.

People

  • Assignee:
    Jody Garnett
    Reporter:
    Jody Garnett
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: