Zfs: The zfsonlinux/zfs wiki is hard to contribute to

[grahamc]

GitHub Wikis don't have a way for non-committers to make suggestions other than opening an issue saying "please add xxx to the wiki".

I found this: https://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html maybe it would be useful.

Here are a couple things I've considered adding to the wiki, but stopped after realizing it wasn't easy to do:

1. Adding a ZFS functional test? Make sure to add it to the Makefile in that directory, and tests/runfiles/common.run to have the CI system run it.
2. Working on ZFS on NixOS? nix-shell '<nixpkgs>' -A zfs then run patchPhase; autoreconfPhase; configurePhase and then run buildPhase each time you want to compile.

edit to make this ticket useful and not a gripe (sorry): is this repo's wiki a good place to be putting this information, and should I open tickets for small updates like these two?

[behlendorf]

I agree. The options Github provides for wiki access aren't great and I'm sure it prevents many people from contributing. The approach you linked to looks interesting and in something we could definitely look in to setting up.

I think adding this kind of request to this repository is absolutely fine, and helps us track the issue.

[Ornias1993]

In my opinion all wiki here should be fully migrated to the OpenZFS wiki in due time anyway.

[ghfields]

With the move of the ZFS repo to the OpenZFS account (scheduled for Feb 25), this seems like a TODO item to consider after everything settles.

FYI.. On Feb 10th, the same link has been shared within the OpenZFS dev slack channel with some positive feedback.

[ghfields]

Yesterday, we had another person ask about making wiki contributions easier. With the repo move successfully completed, it may be time to give this a bit of attention.

[Ornias1993]

@ghfields if we move the content of the Github wiki (deleting outdated content) to the actual OpenZFS wiki, that would open up a lot of flexible options for moderation and segregating github and wiki moderation/access...

[Ornias1993]

I found a simple solution to this issue:
There is an easy github action, which can be used to select a directory in the main repository ( /wiki for example) to contain .md files that will be automatically added/modified on the wiki on every push :)

[gmelikov]

We moved our wiki into a separate repo https://github.com/openzfs/openzfs-docs , where you can easily make a Pull Request, everybody is welcome to contribute!

[grahamc]

Thanks!

On Sat, May 23, 2020, at 8:30 AM, George Melikov wrote:

Closed #9969 https://github.com/openzfs/zfs/issues/9969.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub https://github.com/openzfs/zfs/issues/9969#event-3367002008, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAASXLAGMFESY3KTOJ3546DRS66VZANCNFSM4KRWZVUQ.