Loomio
Sat 12 Nov 2022 8:27PM

Time to consolidate wikis?

NS Nathan Schneider Public Seen by 212

As I've been trying to provide better documentation for newcomers, I'm realizing our documentation is a bit all over the place. Currently we have:

And there may be more.

I believe that we should have all this information in one clear, convenient place so that newcomers (and oldcomers like me, who struggled to find all this stuff) can easily understand how Social.coop works. To that end, I propose that we consolidate all Social.coop information into a single wiki that is appropriately editable by community members. @Christina Bowen @Tom Resing @Boris Mann @Flancian have expressed interest in this.

A proposal could be something like:

  • Bring all material into the official wiki.social.coop and ensure all working groups have access to edit it in Git

    • Can that system be deployed automatically based on Git repo updates?

  • Create a new wiki with SSO to Social.coop accounts, so all members can edit it

    • I've found dokuwiki works nicely with SSO and is simple to deploy and maintain and edit

Okay—thoughts before we make a proposal?

NS

Nathan Schneider Mon 14 Nov 2022 1:02AM

I agree with you here.

The current model is based on a GitLab "wiki," which means there is no branching, etc. Just updates.

I think this could work if we assume the wiki should only ever be edited by a subset of the community, eg. working group members.

If we don't want to operate on that assumption, we should move to something more accessible like DokuWiki.

AU

Ana Ulin Mon 14 Nov 2022 1:57AM

Which brings us back to Christina's questions above, and specifically her points #1 and #4. :-)

Personally, I'm surprised there is even a question that ideally all social.coop members would co-maintain some kind of knowledge base. It seems to me pretty obvious that having things restricted to WG-only is a big reason we don't have up-to-date and clear information for members and, especially, newcomers. Can you explain why think that limiting editing to WGs is desirable?

CCE

Clark C. Evans Mon 14 Nov 2022 8:57PM

Ana, I wonder if it's merely a lack of documentation and training videos, or, if there is software that helps automate the underling process (of markdown static websites)? This underlying workflow is robust, extensible, and auditable. As a side note, this process could use meta-data that tracks when content has been last reviewed for accuracy, to distinguish stale vs stable content. By contrast, most wiki oriented solutions lack these qualities, and the content ends up lacking review due to opaque storage layer. - Clark

AU

Ana Ulin Mon 14 Nov 2022 9:54PM

In my experience, it is not a lack of documentation or training. Fundamentally, a git-based editing process tends to be overly complex and alienating to those who don't already use Git regularly and fluently. But I'm repeating myself.

CB

Christina Bowen Tue 15 Nov 2022 12:12AM

@Clark C. Evans, I don't think docuwiki or wikiJS have opaque storage - i think they both support editing either from the wiki or via git? As I understand it the git storage makes version control clear, and the wiki editor makes the learning curve for contributing less steep.

NS

Nathan Schneider Tue 15 Nov 2022 5:22PM

DokuWiki has excellent version control, but not with Git.

I concur with @Ana Ulin. I am fairly technical, and I still find Git really hard to understand—unnecessarily complex for a wiki. I just actually built a GitLab-based wiki and found that my students had a really hard time using it. So I would lean away from an approach that requires use of a Git repo.

MAC

Marcelo Avelar Cohen Mon 14 Nov 2022 4:55AM

It is amazing that a lot of people are sharing their opinion and ideas.

I would accept a proposal to Bring all material into the official wiki.social.coop and them create a new proposal about editing control.

The need to a more clear information for newcomers like me is crucial to the members begin participating.

ED

emi do Tue 15 Nov 2022 3:55PM

I can often fall into the trap of just 'doing the thing' and not thinking about why I'm doing the thing. As a working group member, and one that worked on the CoC process/ updating the wiki in git a couple of years ago, I will be the first to echo @Ana Ulin that it is not very accessible. It evolved from the easiest to implement solution set up when social.coop was first established but probably hasn't scaled very well. In terms of registration, moderation, server access, use of git...it makes sense to me to keep these limited to WG members so that we have a proper on-boarding process before members can make possibly irreversible changes.

NS

Nathan Schneider Tue 15 Nov 2022 5:23PM

Agreed on all points.

In this case, following @Ana Ulin's concern, it might be best to call the document a "handbook" rather than a "wiki," to clarify that it is not meant to be universally editable.

But @emi do just to clarify: Have you edited the current version of wiki.social.coop recently? I found the current version actually quite easy to edit, with no git workflows, just markdown files. It can be edited by anyone with proper permissions here.

NS

Poll Created Tue 15 Nov 2022 5:35PM

Draft proposal ideas—what do you think? Closed Fri 18 Nov 2022 5:02PM

Please rank the options below (1 is dislike, 5 is really like) to help guide the development of a proposal.

Results

Results Option Points Mean Voters
Consolidate all operational information into a single document (unless it is sensitive) 156 3.8 41
Rename the "wiki" to "handbook" to clarify that it is not universally editable 136 3.3 41
It's okay for just working group members to have permissions to edit 132 3.2 41
All members of Social.coop should be able to edit the wiki 120 2.9 41
I like how the current wiki.social.coop looks—it just needs to be better maintained 93 2.3 41
I think we should move to another platform, e.g., DokuWiki or Wiki.js 88 2.1 41
Undecided 0 0 185

41 of 226 people have participated (18%)

Load More