On Fri, Oct 22, 2021 at 10:14 AM David Sterba [off-list ref] wrote:

Hi,

I'd like to change the way wiki contents is going to be updated, and
would like to get some feedback eventually.

Current status is quite unpleasant, the number of active editors is 1
(me), with other occasional contributions. I somehow feel that the wiki
concept as community editing does not work, specifically for our wiki,
or maybe in general, anymore.

I don't intend to remove the wiki, it's been linked from various places
and people are probably used to looking up the info there. What I'd like
to change is how the updates appear there.

I think the first hurdle is the separate registration. There's 1 new
account request per two weeks, but no actual edits following.

In addition to direct wiki edits, I'd like to provide a git based
workflow, on github. A separate repository would be clean but IMHO
harder to discover, so the idea is to reuse btrfs-progs for that purpose.

Selected pages from wiki will be "locked", with a disclaimer that they
need to be edited via git. Then in btrfs-progs/Documentation will be the
raw mediawiki source file. Edit this and send a pull request. I'll do
the sync to wiki periodically.

The manual pages are now synced like that, so this would allow us to
also use the asciidoc format as source.

For me personally using a local editor for writing documentation is much
more comfortable than the browser textarea. If this would motivate
someone else to contribute too, it's worth it.

(Other option researched: readthedocs.com, git-based but it has a
different structure than wiki and is on another site.)

It'd probably be good if we could eventually convert it to
Sphinx-based documentation like the rest of the Linux kernel
documentation. We could use readthedocs or reuse btrfs.kernel.org for
this.




--
真実はいつも一つ！/ Always, there's only one truth!