Hashar has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/356558 )

Change subject: LICENSE to markdown and add it to doc
......................................................................

LICENSE to markdown and add it to doc

The yard generated documentation does not include the license.

Switch LICENSE.txt to markdown and rename it LICENSE.md
Use yard syntax to include the file on the front page. Requires to tweak
yard options (.yardopts) to make it process *.md files.

Bug: T94001
Change-Id: I515fa52e3ef03c48892d2208eb98a5d8da7e5bae
---
M .yardopts
M CREDITS
R LICENSE.md
M README.md
4 files changed, 12 insertions(+), 11 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/ruby/api 
refs/changes/58/356558/1

diff --git a/.yardopts b/.yardopts
index 55f8671..c9311b2 100644
--- a/.yardopts
+++ b/.yardopts
@@ -1 +1,2 @@
 --title "MediaWiki Ruby API"
+- '*.md'
diff --git a/CREDITS b/CREDITS
index 702615a..12e9d02 100644
--- a/CREDITS
+++ b/CREDITS
@@ -2,7 +2,7 @@
 GNU General Public License v2. We would like to recognize the
 following names for their contribution to the product.
 
-For further details on licensing, see the LICENSE file.
+For further details on licensing, see the LICENSE.md file.
 
 == Developers ==
 * Amir Aharoni
diff --git a/LICENSE.txt b/LICENSE.md
similarity index 97%
rename from LICENSE.txt
rename to LICENSE.md
index 29331b4..7b2373a 100644
--- a/LICENSE.txt
+++ b/LICENSE.md
@@ -1,6 +1,6 @@
-== License and copyright information ==
+# License and copyright information
 
-=== License ===
+## License
 
 MediaWiki is licensed under the terms of the GNU General Public License,
 version 2 or later. Derivative works and later versions of the code must be
@@ -12,12 +12,12 @@
 https://www.gnu.org/licenses/gpl-2.0.html or '''GNU General Public License'''
 below.
 
-=== Copyright owners ===
+## Copyright owners
 
 MediaWiki contributors, including those listed in the CREDITS file, hold the
 copyright to this work.
 
-=== Additional license information ===
+## Additional license information
 
 Some components of MediaWiki imported from other projects may be under other
 Free and Open Source, or Free Culture, licenses. Specific details of their
@@ -36,7 +36,7 @@
 These icons are trademarked, and used subject to the CC trademark license,
 available at http://creativecommons.org/policies#trademark
 
-== GNU GENERAL PUBLIC LICENSE ==
+# GNU GENERAL PUBLIC LICENSE
 
 Version 2, June 1991
 
@@ -45,7 +45,7 @@
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
 
-=== Preamble ===
+## Preamble
 
 The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -95,7 +95,7 @@
 The precise terms and conditions for copying, distribution and
 modification follow.
 
-== TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION ==
+# TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
 '''0.''' This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
@@ -293,7 +293,7 @@
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-=== NO WARRANTY ===
+## NO WARRANTY
 
 '''11.''' BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -317,7 +317,7 @@
 
    '''END OF TERMS AND CONDITIONS'''
 
-== How to Apply These Terms to Your New Programs ==
+# How to Apply These Terms to Your New Programs
 
 If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
diff --git a/README.md b/README.md
index 82fe1ef..cfeb06b 100644
--- a/README.md
+++ b/README.md
@@ -138,6 +138,6 @@
 
 - Added MediawikiApi#create_article and #create_user.
 
-## [License](../LICENSE.txt)
+## {file:LICENSE.md}
 
 © Copyright 2013-2017, Wikimedia Foundation & Contributors. Released under the 
terms of the GNU General Public License, version 2 or later.

-- 
To view, visit https://gerrit.wikimedia.org/r/356558
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I515fa52e3ef03c48892d2208eb98a5d8da7e5bae
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/ruby/api
Gerrit-Branch: master
Gerrit-Owner: Hashar <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to