Divergence between wiki and source-tree docs
Bug #89339 reported by
Alexander Belchenko
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Bazaar |
Won't Fix
|
Undecided
|
Unassigned |
Bug Description
Proposal from Aaron Bentley:
I think we should fix the divergence between wiki and source-tree docs.
I think it's a good idea to retain the wiki version as the primary
version, because it is easier to update.
Here's what I suggest:
1. switch the wiki versions of the documents to ReST
2. automate the process of copying the latest versions of the wiki
documents into the source tree
3. make updating the source-tree documents part of the release process
To post a comment you must log in.
I'm agree, because this open up more room for documentation cotributors, and even simplify process of docs translations (and include translated versions to distribution).
I want to little proposal: at firts implement python script to automate process of copying the latest versions of the wiki documents into the source tree, and provide coorect way to handle situation when wiki-source not in RSTX format. Just to be sure docs update never fails horribly. And then convert all corresponding wiki-pages to RTSX format.
To implement 3 I propose to create new target in Makefile:
make update-docs