Hi,

On Fri, 26 Jan 2018 at 16:47 Antonio <anto...@vieiro.net> wrote:

> As an experiment I've uploaded the NetBeans DevFaq wiki entries to
>
> https://github.com/vieiro/incubator-netbeans-website/wiki
>

Great!

The idea is to experiment with this to see if it fits our needs.
>

I still haven't heard anything back from my email to infra@ to see whether
GitBox can handle syncing the wiki repo.  Is there a better way to follow
up on this?

The wiki is unrestricted
> right now (I think) but maybe we want to restrict modifications to
> collaborators [1].
> ...
> - AFAIK github's wikis do not support PRs. Approving content may be an
> issue.
>

If the wiki isn't open, then the edit button forks off automatically.
There isn't a PR system still AFAIK, but people could still edit on their
fork and email to request a merge.

Personally I think open permissions makes sense, though - it's more like
the old wiki?

- Store the wiki in a plain github repo (not a wiki one), and use the
> 'gh-pages' to render it to html in github.
>
- Store the wiki in a plain github repo and use the static site
> generator to publish it somewhere else.
>

Not necessarily any different.  It'll probably still render OK without
bothering with gh-pages - Markdown definitely works.

eg. the main Praxis LIVE docs are at http://praxis-live.readthedocs.io (so
simple MkDocs static site builder), but the actual repository at
https://github.com/praxis-live/support/blob/master/docs/index.md is still
fully browsable - all the internal links work.

If we want PR then this might be a better way to go.  On the other hand,
we're limited to the permissions on the repository, although if we use a
separate repository just for the wiki that may not be a problem.  We also
know that standard repositories sync to Apache.  Other issue is the editing
UI on the GitHub side isn't quite as nice - missing the toolbar.

- Use Apache's MoinMoin to render and edit the wiki.
>

AFAIK this is not an option - infra docs state that they're not setting
them up any more.  Anyway, we'd be better convincing infra of the benefits
of hosting a simple git-based wiki system, then everyone gets the benefit,
including a number of other Apache projects that seem to be using GH wikis
already.

Best wishes,

Neil
-- 
Neil C Smith
Artist & Technologist
www.neilcsmith.net

Praxis LIVE - hybrid visual IDE for creative coding - www.praxislive.org

Reply via email to