From: Matthieu Moy <Matthieu.Moy@grenoble-inp•fr>
To: Alexandru Zbarcea <alexz@apache•org>
Cc: git@vger•kernel.org, "Benoit Person" <benoit.person@gmail•com>,
"Célestin Matte" <celestin.matte@ensimag•fr>,
"David Aguilar" <davvid@gmail•com>,
"Elia Pinto" <gitter.spiros@gmail•com>,
"Guillaume Sasdy" <guillaume.sasdy@ensimag•imag.fr>,
"Jeff King" <peff@peff•net>,
"Jeremie Nikaes" <jeremie.nikaes@ensimag•imag.fr>,
"Jonathan Nieder" <jrnieder@gmail•com>,
"Junio C Hamano" <gitster@pobox•com>,
"Masanari Iida" <standby24x7@gmail•com>,
"NGUYEN Kim Thuat" <Kim-Thuat.Nguyen@ensimag•imag.fr>,
"Pavel Volek" <Pavel.Volek@ensimag•imag.fr>,
"Simon Cathebras" <simon.cathebras@ensimag•imag.fr>,
"Stefano Lattarini" <stefano.lattarini@gmail•com>
Subject: Re: [PATCH] add documentation to mw-to-git
Date: Tue, 05 Jul 2016 15:09:44 +0200 [thread overview]
Message-ID: <vpq7fd0jko7.fsf@anie.imag.fr> (raw)
In-Reply-To: <CAGycqjyzXg-FNrp8n9QFE8-uF=OecMyXgHerk_RERiMkpdoz9A@mail.gmail.com> (Alexandru Zbarcea's message of "Mon, 4 Jul 2016 18:27:31 -0400")
Hi, and thanks for your contribution.
Alexandru Zbarcea <alexz@apache•org> writes:
> Signed-off-by: Alexandru Zbarcea <alexz@apache•org>
> ---
> contrib/mw-to-git/Makefile | 44 ++++++++++++-
> contrib/mw-to-git/git-mediawiki.txt | 100 +++++++++++++++++++++++++++++
> contrib/mw-to-git/git-remote-mediawiki.txt | 7 --
> 3 files changed, 142 insertions(+), 9 deletions(-)
Git-Mediawiki did not contain any in-tree documentation, but already has a
user manual:
https://github.com/moy/Git-Mediawiki/wiki/User-manual
I have no objection to moving the documentation in-tree (I even created
an issue a long time ago but never did it:
https://github.com/moy/Git-Mediawiki/issues/9 ). However, you patch
alone does not do that: it partly duplicates the existing user-manual,
and complements it with (useful) things that did not appear there (doc
for "git mw" and a recap of config variables). I think this is a step in
the wrong direction and I'd very much prefer a single documentation.
Two more things to know about Git-Mediawiki:
https://github.com/moy/Git-Mediawiki/issues/34
Move Git-Mediawiki's code out of git.git's contrib/
Essentially, having the code in git.git's contrib does not bring much
today, and reduces the number of potential contributors. There seems to
be a consensus to move it out of git.git and develop it separately.
One consequence is that asciidoc may not be the best choice as a markup
format. Having a format that renders directly on GitHub probably
overweights the benefit of using the same system as Git. GitHub can
render asciidoc, but needs *.asciidoc file names and won't read the
config file AFAIK.
https://github.com/moy/Git-Mediawiki/issues/33
Git-Mediawiki is looking for a new maintainer
Git-Mediawiki was a fun experience, but I'm not using it as much as I
planed, and my time budget for it approaches 0, so a new maintainer
would be very much welcome (typically to fix issue #34 above).
> +COMMANDS
> +--------
> +help::
> + Display help information about git mw.
> +
> +preview::
> + Parse and render local file into HTML. Preview a page without actually pushing it to the wiki.
Better write the commands completely like
git mw help::
to avoid ambiguity with git-remote-mediawiki (which is a separate
command).
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
prev parent reply other threads:[~2016-07-05 13:11 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-04 22:27 [PATCH] add documentation to mw-to-git Alexandru Zbarcea
2016-07-05 13:09 ` Matthieu Moy [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=vpq7fd0jko7.fsf@anie.imag.fr \
--to=matthieu.moy@grenoble-inp$(echo .)fr \
--cc=Kim-Thuat.Nguyen@ensimag$(echo .)imag.fr \
--cc=Pavel.Volek@ensimag$(echo .)imag.fr \
--cc=alexz@apache$(echo .)org \
--cc=benoit.person@gmail$(echo .)com \
--cc=celestin.matte@ensimag$(echo .)fr \
--cc=davvid@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=gitter.spiros@gmail$(echo .)com \
--cc=guillaume.sasdy@ensimag$(echo .)imag.fr \
--cc=jeremie.nikaes@ensimag$(echo .)imag.fr \
--cc=jrnieder@gmail$(echo .)com \
--cc=peff@peff$(echo .)net \
--cc=simon.cathebras@ensimag$(echo .)imag.fr \
--cc=standby24x7@gmail$(echo .)com \
--cc=stefano.lattarini@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox