Currently targeting these changes for 1.2.4.
(see also: https://ccristudio.jira.com/browse/GEOMESASUP-934)
Issue/improvement | Notes | POC/Lead | Status |
---|---|---|---|
Retarget developer manual to contributing to GeoMesa itself | Follows example of other OS projects Current stuff in developer manual should be moved into user manual, probably cleaned up/consolidated | ||
Should user guide assume users are writing Java/Scala code? (Create separate system administrator guide?) | |||
Clarify which parts of data management chapter are Accumulo-specific | |||
Accumulo data store chapter | Can use text from developer manual | ||
Kafka data store chapter | Can use text from developer manual | ||
HBase/Google BigTable data store chapter | |||
Cassandra data store chapter | |||
Spark/Storm | Each has tutorials | ||
Blob store | Described a little bit in command-line tools | ||
Native API | |||
Stream data store | |||
Stats | The stats command line tools are in that section | ||
ETL and converter library | README.md has more information than Sphinx docs | ||
Aggregation operations (e.g. heat maps), WPS | Mentioned in tutorials. |
In many cases there is confusion as to where the definitive documentation for a particular module should be; in the case of the converter library, for example, the README.md is more detailed than the relevant section in the Sphinx manual.
Possible solutions:
/opt/devel/src/geomesa/geomesa-accumulo/geomesa-accumulo-datastore/src/main/scala/org/locationtech/geomesa/accumulo/accumulo.scala