[reSIProcate] moving wiki pages into the source tree / Git?

[Daniel Pocock]

I'm resurrecting this topic, I feel it is important for the following
reasons:

- reducing the number of applications we need to maintain on the web server

- people don't always update the wiki at the same time that they change
the code

On 02/04/2020 12:18, Daniel Pocock wrote:
> 
> There have been various discussions about the future of the wiki
> 
> Problems:
> - many pages are not up to date
> - somebody needs to host the Mediawiki
> - separate set of access controls to manage for each tool (wiki, Git)
> 
> If we move from Mediawiki to Github wiki:
> - we become more dependent on Github
> - people won't be able to edit the wiki with their pull requests, they
> need access rights
> 
> Here is one idea that I have.  There are other ideas and I may start
> separate threads for them too.
> 
> For each page, we make an equivalent README.md or README.rst in each
> sub-directory of the source tree
> 
> 
> Example:
> 
> http://www.resiprocate.org/Repro_Overview
> -> repro/README.md
> 
> http://www.resiprocate.org/ReTurn_Overview
> -> reTurn/README.md
> 
> 
> Content from some pages could move to code comments / doxygen (we would
> get that working again before moving content)
> 
> For some pages, it is not obvious where they should go in the source tree
> 
> 
> If we do this, I feel we need to do it all in one go, we don't want the
> content in different places to diverge.  As soon as we move the wiki pages:
> - we delete them from Mediawiki, or make them all read only
> - we put HTTP redirects in place
> - we take a snapshot of the Mediawiki filesystem and commit it to an
> archive/ directory in the source tree
> - and eventually turn off Mediawiki completely
> 
> Before starting, we probably need to make a spreadsheet with the list of
> pages and the corresponding filenames and redirects
> 
> The main disadvantages:
> - we can no longer have live content like the RSS commit log on the main
> page
> - we can't use all the Mediawiki syntax any more
> 
> _______________________________________________
> resiprocate-devel mailing list
> resiprocate-devel at resiprocate.org
> https://list.resiprocate.org/mailman/listinfo/resiprocate-devel
>