GeoTools

The FAQ should be more visible and contain more answers

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: docs
  • Labels:
    None

Description

Currently the FAQ is hard to find and when you do find it there aren't questions or answers for some of our commonly asked questions.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Michael Bedward added a comment -
Contributions will be gratefully accepted
Show
Michael Bedward added a comment - Contributions will be gratefully accepted
Hide
Permalink
Jody Garnett added a comment - - edited
The FAQ section is hard to maintain if there are code examples; so two ideas to choose from:
- do the FAQ in rst and pull in code examples
- do the FAQ like the "swt snippets" page where each faq is a link to a full code example: http://www.eclipse.org/swt/snippets/ (this is brutal but effective and to the point)

Finally we could make it an index to other parts of the documentation; if you have a question about "crs action order" it can provide the one line answer and link you to http://docs.codehaus.org/display/GEOTDOC/The+axis+order+issue
Show
Jody Garnett added a comment - - edited The FAQ section is hard to maintain if there are code examples; so two ideas to choose from: - do the FAQ in rst and pull in code examples - do the FAQ like the "swt snippets" page where each faq is a link to a full code example: http://www.eclipse.org/swt/snippets/ (this is brutal but effective and to the point) Finally we could make it an index to other parts of the documentation; if you have a question about "crs action order" it can provide the one line answer and link you to http://docs.codehaus.org/display/GEOTDOC/The+axis+order+issue
Hide
Permalink
Jody Garnett added a comment -
I have solved this in the sphinx documentation; the single faq page now "includes" the faq pages defined for each module in the library. This provides a massive page that can be searched in a browser; it also provides a single page strongly associated with each module so developers feel comfortable answering common questions about their module.

Marking this as closed.
Show
Jody Garnett added a comment - I have solved this in the sphinx documentation; the single faq page now "includes" the faq pages defined for each module in the library. This provides a massive page that can be searched in a browser; it also provides a single page strongly associated with each module so developers feel comfortable answering common questions about their module. Marking this as closed.
Hide
Permalink
Jody Garnett added a comment -
(The faq is also now linked from the main website documentation page)
Show
Jody Garnett added a comment - (The faq is also now linked from the main website documentation page)

People

  • Assignee:
    Ian Turton
    Reporter:
    Ian Turton
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: