RFC: plan to allow documentation contributions via github

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

plan: I'd like to allow documentation updates through github web interface.
"patches via mailinglist" will continue to work unchanged.

The current way to clone the git, edit files, send to mailinglist might
discourage people who are not developers or not used to working with git
that way.

There are some issues around the pull request I'm not yet clear how to
resolve.  I'd like to keep the git history clean so the pull requests
will not get merged the usual way. I'll probably merge the
changes/patches manually and then close the request. There shall be a
branch to serve as a starting point for any new edits, but will be a
moving target after the pending patches get merged. I hope this will
work for the browser-only approach, the merging burden is on my side.

In order to get a working 'Preview' for the changes, we'd have to rename
all .txt files to .asciidoc. Then you get a nice formatting on the
github site for free.

You can see an example here:
https://github.com/kdave/btrfs-progs/blob/test-asciidoc/Documentation/btrfs-balance.asciidoc

The documentation is separated from code so we can afford to relax the
submission rules, though we'll still need the signed-off-by and names
for the final commits.

Thanks for feedback.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Filesystem Development]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux