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

[Scott Godin]

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

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.

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

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?

Scott


On Sun, Jan 17, 2021 at 1:39 PM Daniel Pocock <daniel at pocock.pro> wrote:

>
> 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
> >
> _______________________________________________
> resiprocate-devel mailing list
> resiprocate-devel at resiprocate.org
> https://list.resiprocate.org/mailman/listinfo/resiprocate-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.resiprocate.org/pipermail/resiprocate-devel/attachments/20210118/0511f5ec/attachment.htm>