[Geoserver-devel] New Community Module For MapML Support

Hi all,

Peter Rushforth at Natural Resources Canada has been spearheading the development a standard called MapML, and he has contracted Refractions to build support for MapML into Geoserver.

The MapML specification is on GitHub: https://github.com/Maps4HTML/MapML

And there is a Maps 4 HTML W3C community group here: https://www.w3.org/community/maps4html/

After looking over the wiki and contribution guidelines, it seems like the most appropriate place for this code, at least to start, is a community module. I understand I need some approval to create a new community module and get the appropriate access allowed. To that end I have some more technical details of what development is planned, including example output, etc. which I would like to share, and would appreciate any input or suggestions on. Perhaps the github wiki would be the right place for this? Can I get access to this?

There is a good primer on MapML in this blog post from Cubewerx (and includes some example output): http://www.cubewerx.com/mapml/

Please let me know what it will take to move forward with this.

Thanks,

Chris

--
Chris Hodgson
Refractions Research
Suite 419 – 1207 Douglas Street
Victoria, British Columbia
Canada, V8W 2E7
1-250-383-3022
http://www.refractions.net

After looking over the wiki and contribution guidelines, it seems like
the most appropriate place for this code, at least to start, is a
community module. I understand I need some approval to create a new
community module and get the appropriate access allowed.

Yes indeed, that’s how the process goes.
You have my +1 for contributing the module (I believe a single vote is enough).
How are you going to develop it? Is it going to be a one time donation? If so,
you can simply make a pull request for it.
You’ll also going to receive commit access (kindly share your github id) for maintenance
on the module (and for development too, if you want to develop it bit by bit directly
in the GeoServer repository). It comes with no actual restrictions, but you should use it only to commit
to your module, failing to follow these limits will likely result in your commit access be revoked.

Once the module is in good shape enough you can also add it to the nightly build (only
compile, no tests runs, the latter is a privilege for supported modules) so that the
more adventurous users can start testing it:
https://build.geoserver.org/geoserver/master/community-latest/

Longer term, you can push for the module to become an official extension, so that it becomes
available as part of the releases. This requires a long term commitment on part of a designated
maintainer (typically the original author of the module) and a set of extra requirements, that
need to be discussed in a formal proposal. Here is an example of a community graduation
proposal, for your reference:
https://github.com/geoserver/geoserver/wiki/GSIP-170

To that end I
have some more technical details of what development is planned,
including example output, etc. which I would like to share, and would
appreciate any input or suggestions on. Perhaps the github wiki would be
the right place for this? Can I get access to this?

The wiki is mostly used for proposals (you don’t need one for a community module)
and temporary discussion, but not for documentation.
The documentation is an important bit for community modules, it makes the module usable
by end users.
Documentation is version controlled along with the code, see here:
https://github.com/geoserver/geoserver/tree/master/doc/en/user/source/community

So basically you’d go and add a folder in there with the documentation inside.
There is a getting started guide for docs here:
https://docs.geoserver.org/latest/en/docguide/

The documentation would be a god place where you can share how to install and use the module,
and provide either inline text or pointers to external documents describing the MapML
design.

Hope this helps!

Cheers
Andrea

···

GeoServer Professional Services from the experts! Visit http://goo.gl/it488V for more information. == Ing. Andrea Aime @geowolf Technical Lead GeoSolutions S.A.S. Via di Montramito 3/A 55054 Massarosa (LU) phone: +39 0584 962313 fax: +39 0584 1660272 mob: +39 339 8844549 http://www.geo-solutions.it http://twitter.com/geosolutions_it ------------------------------------------------------- Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail.

Thanks Andrea,

My GitHub ID is: cmhodgson

While "one time donation" fairly describes the contribution at this time, there will be a warranty/maintenance period so being able to commit directly would be great.

Thank you for your support and for the thorough run-down of the process!

Cheers,

Chris

Thanks Andrea,

My GitHub ID is: cmhodgson

Sent you an invitation.

While “one time donation” fairly describes the contribution at this
time, there will be a warranty/maintenance period so being able to
commit directly would be great.

Got it. This might mean the module will remain in community land unless some
other developer picks it up and acts as maintainer for it. It is uncommon, but if the
module gets popular it might well happen :slight_smile:

Cheers
Andrea

···

== GeoServer Professional Services from the experts! Visit http://goo.gl/it488V for more information. == Ing. Andrea Aime @geowolf Technical Lead GeoSolutions S.A.S. Via di Montramito 3/A 55054 Massarosa (LU) phone: +39 0584 962313 fax: +39 0584 1660272 mob: +39 339 8844549 http://www.geo-solutions.it http://twitter.com/geosolutions_it ------------------------------------------------------- Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail.