Update documentation for the Geoman plugin

[hansthen]

The Geoman plugin was released in Folium 0.19.6, but has no documentation.

[saheelsapovadia]

Hi @ocefpaf , i am exploring this project for contributions.
With some guidance, I think I can work on the documentation 😊.

[hansthen]

Hi @saheelsapovadia Any help is greatly appreciated. I originally added the Geoman plugin. I have been postponing to add the documentation for some time now. What kind of guidance would you need? There is a general contributor's guide, this is geared mostly for developers, but it mostly works on the documentation. The documentation itself is under the doc folder and written in reStructuredText or markdown.

Do you only want to work on the Geoman documentation or is this your offer broader?

How I typically work is that I write a sample program for a new feature or plugin. I typically do that in Jupyter notebook or Streamlit. I then use that program as the outline for writing the documentation.

[saheelsapovadia]

Hi @hansthen ,
I read the contributor's guide. have done the setup on my local.
i have discovered that there is a makefile in /docs folder.

Do you only want to work on the Geoman documentation or is this your offer broader?

Currently with my limited knowledge i will focus the understanding the plugin to write its documentation. Still would like to know if there's anything around this plugin that needs some work and my help 😎.

[saheelsapovadia]

Also can you assign this issue to me 🚀?

[hansthen]

I assigned the issue to you. The main thing is that we do not have any documentation on this plugin at all in the user_guide/plugins directory. This does not have to be very extensive, as we can point to the upstream geoman documentation: https://geoman.io/docs/leaflet.

In terms of missing functionality: the geoman plugin currently does not have a download button like the Draw plugin. If you want to contribute, I can open a separate ticket for that.

[saheelsapovadia]

I assigned the issue to you. The main thing is that we do not have any documentation on this plugin at all in the user_guide/plugins directory. This does not have to be very extensive, as we can point to the upstream geoman documentation: https://geoman.io/docs/leaflet.

Thanks!

noted, will check it out.

[saheelsapovadia]

In terms of missing functionality: the geoman plugin currently does not have a download button like the Draw plugin. If you want to contribute, I can open a separate ticket for that.

Will also take look on this and update you.

[Balantah]

Hi! I'd like to work on this documentation. I've set up the repo locally and plan to write a basic guide for the Geoman plugin showing how to add it to a map with a code example. Would you be open to a PR from me?

[hansthen]

Yes sure, extra documentation is always welcome. I think someone already added documentation for the Geoman plugin, as this issue is closed, but you are welcome to expand the current documentation.