docs icon indicating copy to clipboard operation
docs copied to clipboard

Fix docs to say that Github wiki Internal link format doesn't match MediaWiki link format

Open abdullin opened this issue 2 years ago • 6 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/communities/documenting-your-project-with-wikis/editing-wiki-content

What changes are you suggesting?

Documentation says that github docs use MediaWiki syntax:

With MediaWiki syntax, the link syntax is [[Link Text|nameofwikipage]]. This is incorrect. While MediaWiki syntax is exactly the opposite, as documented in MediaWiki Links: [[nameofwikipage|Link Text]]

I suggest to make it explicit that Github wiki uses an ad-hoc interpretation of wikilinks, that isn't compatible with MediaWiki internal links or Wikipedia internal links.

Additional information

No response

abdullin avatar Jul 26 '22 14:07 abdullin

@abdullin Thanks for opening an issue - I'm not sure why the bot closed your first one out, but we appreciate you opening another! 💛

I'll get this triaged for the team to take a look 👀

cmwilson21 avatar Jul 27 '22 20:07 cmwilson21

@cmwilson21 thanks.

The bot was right - I forgot to fill the proper issue title :)

abdullin avatar Jul 27 '22 21:07 abdullin

@abdullin Gotcha! Thanks for letting me know. I was thinking our bot was on the fritz. 😄

cmwilson21 avatar Jul 28 '22 17:07 cmwilson21

Thank you for your suggestion! ✨ You or anyone else can feel free to open a pull request to update the example in the Adding Links section to say [[nameofwikipage|LinkText]], instead of the current order.

SiaraMist avatar Aug 09 '22 17:08 SiaraMist

Submitted a fix at https://github.com/github/docs/compare/main...matthew0420:docs:patch-1

matthew0420 avatar Aug 11 '22 15:08 matthew0420

@matthew0420 Thanks for making a fix. ✨

Can you open a pull request for it? ⚡

cmwilson21 avatar Aug 12 '22 13:08 cmwilson21

@cmwilson21 Pull request should be up, link here: https://github.com/github/docs/pull/19710

matthew0420 avatar Aug 12 '22 15:08 matthew0420