On Mon, Feb 16, 2015 at 6:13 PM, Uwe Stöhr <[email protected]> wrote: > Am 12.02.2015 um 22:05 schrieb Scott Kostyshak: > >> Uwe, would you mind starting a section on our policy for >> documentation? We have a file lib/doc/Development.lyx where chapter 4 >> is on "Development policies". > > > I added there now a chapter 5 (in master only). Feel free to change this. > > regards Uwe
Looks great, Uwe! Thank you for doing this. Regarding rule 4, I wonder if it makes more sense to put the burden on the *committer* of copying the changes to the manuals in other languages, rather than the document maintainer. The way you state it makes me think that if you are the document maintainer, you have to pay close attention to commits that alter your document. But if you go away for a while or you miss a commit, it seems the other language documents could easily get out of sink. Unless you do this at a specific time, for example a month before release you go through the track changes and copy them over to the other languages all at once. Actually maybe that makes more sense. Is that what you have in mind? Someday I would like to add a rule that when a document is changed, the corresponding tests should be run. But right now our testing procedure is not robust enough and not available to everyone (I think it's not straightforward if using Autotools). Scott
