qwat / docs

TEKSI Water module (project QWAT) - Documentation
https://qwat.github.io/docs
Apache License 2.0
3 stars 11 forks source link

Update doc to transifex in a more frequent way like QGEP #18

Closed ponceta closed 2 years ago

ponceta commented 2 years ago

As discussed with @m-kuhn

https://github.com/QGEP/docs/commit/11fec125dd711b5874fe671eb9f18bbfbb183402#diff-87db21a973eed4fef5f32b267aa60fcee5cbdf03c67fafdc2a9b553bb0b15f34

m-kuhn commented 2 years ago

qwat docs and qgep docs are currently structured in a different way:

compare:

qwat has a doc release per version, qgep one single release for "master"

ponceta commented 2 years ago

As you mention QWAT doc was initially designed to reflect QWAT version state.

I would prefer a single master doc approach like qgep with only master as a reference.

This would imply that when we write some documentation about a new functionnality, we also mention what version is required to benefit from it.

QWAT and QGEP should work in the same way for the documentation process so we are not lost when updating it. (Since it is mainly the same people who are updating the documentation)