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

[Daniel Pocock]

On 18/01/2021 15:39, Scott Godin wrote:
> Hi Daniel,
> 
> I've been exploring the Github wiki tab, and have tested moving a few
> pages over.  GitHub now supports showing MediaWiki formatting (not
> everything works, but basic pages show up nicely):
> https://github.com/resiprocate/resiprocate/wiki/Main_Page
> https://github.com/resiprocate/resiprocate/wiki/We-Use-ReSIProcate

The biggest problem with using any wiki (Github wiki, MediaWiki) is that
when developers change code, they do not always change the wiki.

While in some cases I'm adverse to over-reliance on Github, in this
particular case, my biggest concern is that we will simply have the same
problem of pages becoming stale.  That is the primary reason for my proposal

As a related issue, we also have some txt files in the repository
already.  I don't think we will move them to the wiki, I think it is
better to go the other direction, moving more things from wiki into
those files.

> What I've done so far doesn't align completely with your idea to have it
> directly in the resiprocate GIT repo, it is in a GIT repo that sits
> beside resip:   
> https://github.com/resiprocate/resiprocate*.wiki.git*
> I like your idea to have a docs directly in our repo though, it should
> be an easy process to just move them.  I have started a spreadsheet with
> all the pages we have listed on it.  It has a completed and notes
> column.  It does not contain information about all the links on each page.

We may be able to get a full page list from MediaWiki as a CSV and use
that to create redirects.

> I'm not too concerned about the missing RSS feeds, as you can easily
> view Git history right from GitHub.

Yes, I just mentioned that to be comprehensive in my analysis but it
doesn't bother me too much either.

> I'm tracking a number of broken links to our Doxygen documentation, so
> it would be good to get that restored somewhere soon.  Any idea
> where/how we can host that without needing our own server?

We could try to use IPFS for that, as with the release artifacts

We may simply need a static web hosting server for that content and a
script to keep it in sync with each build.

Regards,

Daniel