No bikeshedding? Then .wiki , brevity wins. [1], thanks.

On Wed, Nov 4, 2015 at 6:37 AM, Marcin Cieslak <[email protected]> wrote:

> If both "README" and "README.mediawiki" were present


It feels odd to have both. We have this in core for historical reasons,
Krenair added:
   Symlink README.mediawiki to README so Github renders it as wikitext.



> ... I'd tend to think
> that this is some imported piece of software and README is the upstream
> README file and README.mediawiki contains MW-specific bits (like
> import/upstreaming instructions, whatever). Something we might start
> to see in vendor/ eventually.
>

Good point, though e.g. README_MediaWiki.wiki would be less confusing if
they have different content.


> Somehow funny we cannot use our own markup where we need to :)
>

We can: again, GitHub will render some MediaWiki syntax in files with the
extension.wiki [2]. Phabricator's diffusion renders them as text, which is
no worse than a file without extension.
Also, there's a chance [3] we'll gain the ability to transclude doc files
in git into wiki pages for some DRY [4] win, e.g. with the Android README
that Stephen Niedzielski mentioned.

[1]
https://www.mediawiki.org/w/index.php?title=Manual%3ACoding_conventions&type=revision&diff=1931325&oldid=1931314
[2] https://help.github.com/articles/supported-mediawiki-formats/
[3] https://phabricator.wikimedia.org/T91626
[4] https://en.wikipedia.org/wiki/Don't_repeat_yourself

-- 
=S Page  WMF Tech writer
_______________________________________________
Wikitech-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Reply via email to