search

netzmacht / contao-leaflet-maps

Leaflet maps extension for Contao CMS
12 stars 8 forks source link

User documentation #9

Closed dmolineus closed 5 years ago

kikmedia commented 8 years ago

Well, as a user for the last year I should be able to provide some documentation. Is there already a place for that?

dmolineus commented 8 years ago

I would really appreciate if you start contributing to the documentation. At the moment there is no documentation at all. So any help no matter if english or german would be really great.

I'd prefer managing the documentation using github and the reStructuredText format.

Are you familar familiar with the reStructuredText documentation style and would contribute using git? MetaModels or Contao-Bootstrap uses it as well.

Otherwise using the Contao wiki could be an alternate place.

kikmedia commented 8 years ago

Yes I am, yes I will ... ;-)

Do we need a seperate repository for the docs? Should be created by you as the project owner, I think.

dmolineus commented 8 years ago

Great! Yes, I'll create a new repo for it with a base structure. Gonna add you as contributor.

kikmedia commented 8 years ago

+1

dmolineus commented 8 years ago

I created a repo for the docs. It can be found here https://github.com/netzmacht/contao-leaflet-docs. It contains a base structure for the german language. If you prefer writing english I would adjust it. Feel free to extend/change the structure.

The ReadTheDocs page is here http://leaflet-maps-for-contao.readthedocs.org/ and gets autoamtically updated after pushing to the master branch.

If anything else is missing, feel free to ask. You should have received an invitation for the repo.

sebj54 commented 5 years ago

Hi! Thanks for your amazing extension, it is very useful!

I have just one little request: could you add a link to this documentation in the README of this repository? Thanks! :)

dmolineus commented 5 years ago

Documentation is now added to the composer support section and to the readme as we.

Closing this issue as nothing happened during the last 4 years here. Anyone is still welcome to contribute to this project/documentation.