Open landryb opened 1 year ago
thanks @landryb this proposal seems relevant to me i'd add a matching version number in any doc, assuming some users may print it
Documentation is an important point for us too in DataGrandEst and a limit for developpement of using applications like MapStore. Markdown is better than ReSt for me. I already test mkdocs (with mkdocs-material plugin) for a project (cf. https://www.datagrandest.fr/tools/dge-dataviz-components/documentation/index.html - not yet linked to a GitHub repository) and it's a good choice according to me.
+1
If the documentation is mapstore-specific, it is best located in https://github.com/georchestra/mapstore2-georchestra/
If the goal is to write a documentation for geOrchestra, then another repository should be used. BTW, there's already plenty of content in https://github.com/georchestra/data-admin-book/tree/master/fr
What about the documentation made by geosolutions : https://docs.georchestra.geo-solutions.it/en/latest/ ? It should be an entry point to the documentation no ? Source is in https://github.com/georchestra/mapstore2-georchestra/tree/master/docs/source , I think. If we want to change the format, it will be necessary to modify this one too.
The PSC is opening the review of this proposal. Will be close on the 15/12/2022.
+1
+1
obviously voting :+1:
+1 for this proposal. We really need that. Then we should discuss on the how. See this on january 2022.
+1
+1
+1
:+1:
+1
Everyone in the PSC voted, the GIP is now Adopted
, this issue will be linked at by future work implementing it.
I reopen and add the "work in progress" label ;)
To follow since the hackaton ended yesterday in Rennes :
I let this issue open until we got finished some points :
The new cadastrapp documentation is avalaible since june 2023.
Who ?
CRAIG / @landryb / @MarieSuet
Target Module
Mapstore first, & other georchestra modules second.
What ?
The community resorts to:
we need to improve that.
Why ?
We need to overhaul our documentation, as already noted/discussed in georchestra/georchestra#3791
our users dont have a proper french documentation for mapstore2, and some initiatives already started some instance-tailored word/pdf documentation (rennes, le puy en velay cf https://geoportail.lepuyenvelay.fr/prise-en-main-de-mapstore2/) but it would be better to have:
How ?
Any potential pitfalls and ways to circumvent them ?
as every documentation, it tends to get outdated/not in sync when the subcomponents are updated..but at least having something would be better than nothing.
having versioned docs would allow to clearly state against which version a documentation was written.
the proposal is to start by mapstore user doc in french (yeah i know..), then other components (console...)
When ?
work might start before the end of the year. No specific release is targeted, but at least documenting the current mapstore releases (2022.01, etc..)
Votes
Project Steering Committee
Community support