Change Details

====Brief summary====
The [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki action API ]] is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. Several Wikimedia projects make use of this API.
As of now, there are [[ https://www.mediawiki.org/wiki/Category:MediaWiki_action_API | ~128 pages ]] on the Action API on MediaWiki.org. #developer-advocacy did a little [[ https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Research_on_the_state_of_the_docs_of_mw_action_api | research on the state of the docs ]] and documented a few problems and recommendations for the next steps. One of the issues we decided to address was inconsistency. For example, some pages had the automated API docs embedded; some didn’t, some pages had code samples, some didn’t, etc. As a first step, we designed a [[ https://www.mediawiki.org/wiki/API:Documentation_template | documentation template ]] and used it to re-write top 20 viewed pages of the API. But, we realized we could not improve 128 pages all by ourselves, and opened it to new Wikimedia contributors for help :-) Our Outreachy intern @Martyav put in a lot of good work in this and improved the next ~20 pages and brought this project in good shape!
The goal of this project is to improve documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki using the documentation template.
(OPTIONAL) If there is more time, then the next part of the project could be developing one or two demo apps around the use of Action APIs.
====Skills required====
Wiki editing, Templates, creating and managing translatable pages, [[ https://phabricator.wikimedia.org/ | Wikimedia Phabricator ]] tool, basic Python programming. Note: some or all of these skills would be nice to have but not required. Come with a desire to learn and that be all!
==== Code repository====
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples
==== Microtasks====
1. Two issues on Github around improving existing code samples:
| Issue | Work in progress | Done
| Build the UI for account creation form via [[ https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bauthmanagerinfo | Authmanagerinfo ]] module. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/10#issuecomment-434744505 | View issue on Github ]]. | @shruthishridhar |
| Add an example to demonstrate the use of [[ https://www.mediawiki.org/wiki/API:Links | API:Links ]] module to identify red links on a page. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/37 | View issue on Github ]]. | @Didicodes, @Supriyasupu | @jeropbrenda
2. Pick an API page to work on and add your Phabricator username next to it in the relevant column:
| API page | Work in progress | Done
| [[ https://www.mediawiki.org/wiki/API:Block | API:Block ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Emailuser | API:Emailuser ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Options | API:Options ]] | @Areefa |
| [[ https://www.mediawiki.org/wiki/API:Logevents | API:Logevents ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Blocks | API:Blocks ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Recentchanges | API:Recentchanges ]] |@Oragonics | @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Embeddedin | API:Embeddedin ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Exturlusage | API:Exturlusage ]] | @Olena23 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @Manvigupta7 |
| [[ https://www.mediawiki.org/wiki/API:SetPageLanguage | API:SetPageLanguage ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Deletedrevs | API:Deletedrevs ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Querypage | API:Querypage ]] || @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Allrevisions | API:Allrevisions ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Compare | API:Compare ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Upload | API:Upload ]] | @Mansi29ag |
| [[ https://www.mediawiki.org/wiki/API:Import | API:Import ]] | @shruthishridhar |
| [[ https://www.mediawiki.org/wiki/API:Rollback | API:Rollback ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Protect | API:Protect ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Tags | API:Tags ]] | @Edisonabah |
| [[ https://www.mediawiki.org/wiki/API:Categoryinfo | API:Categoryinfo ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Langlinks | API:Langlinks ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Allfileusages | API:Allfileusages ]] | @Nikitrain|
| [[ https://www.mediawiki.org/wiki/API:Iwlinks | API:Iwlinks ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Pagepropnames | API:Pagepropnames ]] | @Didicodes|
| [[ https://www.mediawiki.org/wiki/API:Watchlist | API:Watchlist ]] | @SilkyPriya @Nimbus20 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @dave_oh |
====Getting started instructions for third microtask====
- Set up [[ https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | Git ]] on your computer and a [[ https://github.com/ | Github account ]] if you don’t already have one. Learn how to use both.
- Set up a [[ https://www.mediawiki.org/wiki/MediaWiki | MediaWiki account ]] if you don’t already have one.
- Read the project description thoroughly and the [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki Action API ]] too.
- Pick an action page from the table above that you would like to review and improve. Add your name next to the project in the “Work in progress” column. You will need to be logged into Phabricator and subscribed to the task and only then you will be able to edit the task description
- Create a page in your Sandbox (https://www.mediawiki.org/wiki/User:your_username/Sandbox/API:pagename) and do not make edits directly to the API pages.
- Fill it with the template content which is in here: https://www.mediawiki.org/wiki/API:Documentation_template (copy and paste). We encourage you to stick to the template if for some reason you feel the urge to add or remove any section, discuss with your mentors.
- For your reference, read a couple recent API pages that we modified using the new template: [[ https://www.mediawiki.org/wiki/API:Geosearch | API:Geosearch ]], [[ https://www.mediawiki.org/wiki/API:Parsing_wikitext | API:Parsing_wikitext ]]
- Contribute sample code for the API page to this repository: https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples. Please read the [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples#contributing-code-samples | contribution guidelines ]] before starting to work on a topic.
- When you are done, ping @srishakatux on Zulip and get some feedback on your work.
- Incorporate feedback. Once you get a green signal, coordinate with mentors in getting your changes integrated with the actual page on MediaWiki.org.
- Finally, add your name next to the project in the “Done” column in the table above.
====Mentor(s)====
@Srishakatux @srodlund
====Get in touch with mentors====
Ask a question in the topic `Phab:T215682 API documentation improvements` under https://wikimedia.zulipchat.com/#narrow/stream/180873-gsoc19-outreachy18
==== Resources ====
* How to use or write Templates https://www.mediawiki.org/wiki/Help:Templates
* Page translation https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example
* Editing wiki pages https://www.mediawiki.org/wiki/Help:Editing
* Learn how to use Phabricator https://www.mediawiki.org/wiki/Phabricator/Help

====Brief summary====
The [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki action API ]] is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. Several Wikimedia projects make use of this API.
As of now, there are [[ https://www.mediawiki.org/wiki/Category:MediaWiki_action_API | ~128 pages ]] on the Action API on MediaWiki.org. #developer-advocacy did a little [[ https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Research_on_the_state_of_the_docs_of_mw_action_api | research on the state of the docs ]] and documented a few problems and recommendations for the next steps. One of the issues we decided to address was inconsistency. For example, some pages had the automated API docs embedded; some didn’t, some pages had code samples, some didn’t, etc. As a first step, we designed a [[ https://www.mediawiki.org/wiki/API:Documentation_template | documentation template ]] and used it to re-write top 20 viewed pages of the API. But, we realized we could not improve 128 pages all by ourselves, and opened it to new Wikimedia contributors for help :-) Our Outreachy intern @Martyav put in a lot of good work in this and improved the next ~20 pages and brought this project in good shape!
The goal of this project is to improve documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki using the documentation template.
(OPTIONAL) If there is more time, then the next part of the project could be developing one or two demo apps around the use of Action APIs.
====Skills required====
Wiki editing, Templates, creating and managing translatable pages, [[ https://phabricator.wikimedia.org/ | Wikimedia Phabricator ]] tool, basic Python programming. Note: some or all of these skills would be nice to have but not required. Come with a desire to learn and that be all!
==== Code repository====
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples
==== Microtasks====
1. Two issues on Github around improving existing code samples:
| Issue | Work in progress | Done
| Build the UI for account creation form via [[ https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bauthmanagerinfo | Authmanagerinfo ]] module. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/10#issuecomment-434744505 | View issue on Github ]]. | @shruthishridhar |
| Add an example to demonstrate the use of [[ https://www.mediawiki.org/wiki/API:Links | API:Links ]] module to identify red links on a page. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/37 | View issue on Github ]]. | @Didicodes, @Supriyasupu | @jeropbrenda
2. Pick an API page to work on and add your Phabricator username next to it in the relevant column:
| API page | Work in progress | Done
| [[ https://www.mediawiki.org/wiki/API:Block | API:Block ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Emailuser | API:Emailuser ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Options | API:Options ]] | @Areefa |
| [[ https://www.mediawiki.org/wiki/API:Logevents | API:Logevents ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Blocks | API:Blocks ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Recentchanges | API:Recentchanges ]] |@Oragonics | @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Embeddedin | API:Embeddedin ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Exturlusage | API:Exturlusage ]] | @Olena23 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @Manvigupta7 |
| [[ https://www.mediawiki.org/wiki/API:SetPageLanguage | API:SetPageLanguage ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Deletedrevs | API:Deletedrevs ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Querypage | API:Querypage ]] || @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Allrevisions | API:Allrevisions ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Compare | API:Compare ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Upload | API:Upload ]] | @Mansi29ag |
| [[ https://www.mediawiki.org/wiki/API:Import | API:Import ]] | @shruthishridhar |
| [[ https://www.mediawiki.org/wiki/API:Rollback | API:Rollback ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Protect | API:Protect ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Tags | API:Tags ]] | @Edisonabah |
| [[ https://www.mediawiki.org/wiki/API:Categoryinfo | API:Categoryinfo ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Langlinks | API:Langlinks ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Allfileusages | API:Allfileusages ]] | @Nikitrain|
| [[ https://www.mediawiki.org/wiki/API:Iwlinks | API:Iwlinks ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Pagepropnames | API:Pagepropnames ]] | @Didicodes|
| [[ https://www.mediawiki.org/wiki/API:Watchlist | API:Watchlist ]] | @SilkyPriya @Nimbus20 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @dave_oh |
| [[ https://www.mediawiki.org/wiki/API:Account creation | API:Account creation ]] | @Arrsquare |
====Getting started instructions for third microtask====
- Set up [[ https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | Git ]] on your computer and a [[ https://github.com/ | Github account ]] if you don’t already have one. Learn how to use both.
- Set up a [[ https://www.mediawiki.org/wiki/MediaWiki | MediaWiki account ]] if you don’t already have one.
- Read the project description thoroughly and the [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki Action API ]] too.
- Pick an action page from the table above that you would like to review and improve. Add your name next to the project in the “Work in progress” column. You will need to be logged into Phabricator and subscribed to the task and only then you will be able to edit the task description
- Create a page in your Sandbox (https://www.mediawiki.org/wiki/User:your_username/Sandbox/API:pagename) and do not make edits directly to the API pages.
- Fill it with the template content which is in here: https://www.mediawiki.org/wiki/API:Documentation_template (copy and paste). We encourage you to stick to the template if for some reason you feel the urge to add or remove any section, discuss with your mentors.
- For your reference, read a couple recent API pages that we modified using the new template: [[ https://www.mediawiki.org/wiki/API:Geosearch | API:Geosearch ]], [[ https://www.mediawiki.org/wiki/API:Parsing_wikitext | API:Parsing_wikitext ]]
- Contribute sample code for the API page to this repository: https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples. Please read the [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples#contributing-code-samples | contribution guidelines ]] before starting to work on a topic.
- When you are done, ping @srishakatux on Zulip and get some feedback on your work.
- Incorporate feedback. Once you get a green signal, coordinate with mentors in getting your changes integrated with the actual page on MediaWiki.org.
- Finally, add your name next to the project in the “Done” column in the table above.
====Mentor(s)====
@Srishakatux @srodlund
====Get in touch with mentors====
Ask a question in the topic `Phab:T215682 API documentation improvements` under https://wikimedia.zulipchat.com/#narrow/stream/180873-gsoc19-outreachy18
==== Resources ====
* How to use or write Templates https://www.mediawiki.org/wiki/Help:Templates
* Page translation https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example
* Editing wiki pages https://www.mediawiki.org/wiki/Help:Editing
* Learn how to use Phabricator https://www.mediawiki.org/wiki/Phabricator/Help

====Brief summary====
The [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki action API ]] is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. Several Wikimedia projects make use of this API.
As of now, there are [[ https://www.mediawiki.org/wiki/Category:MediaWiki_action_API | ~128 pages ]] on the Action API on MediaWiki.org. #developer-advocacy did a little [[ https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Research_on_the_state_of_the_docs_of_mw_action_api | research on the state of the docs ]] and documented a few problems and recommendations for the next steps. One of the issues we decided to address was inconsistency. For example, some pages had the automated API docs embedded; some didn’t, some pages had code samples, some didn’t, etc. As a first step, we designed a [[ https://www.mediawiki.org/wiki/API:Documentation_template | documentation template ]] and used it to re-write top 20 viewed pages of the API. But, we realized we could not improve 128 pages all by ourselves, and opened it to new Wikimedia contributors for help :-) Our Outreachy intern @Martyav put in a lot of good work in this and improved the next ~20 pages and brought this project in good shape!
The goal of this project is to improve documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki using the documentation template.
(OPTIONAL) If there is more time, then the next part of the project could be developing one or two demo apps around the use of Action APIs.
====Skills required====
Wiki editing, Templates, creating and managing translatable pages, [[ https://phabricator.wikimedia.org/ | Wikimedia Phabricator ]] tool, basic Python programming. Note: some or all of these skills would be nice to have but not required. Come with a desire to learn and that be all!
==== Code repository====
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples
==== Microtasks====
1. Two issues on Github around improving existing code samples:
| Issue | Work in progress | Done
| Build the UI for account creation form via [[ https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bauthmanagerinfo | Authmanagerinfo ]] module. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/10#issuecomment-434744505 | View issue on Github ]]. | @shruthishridhar |
| Add an example to demonstrate the use of [[ https://www.mediawiki.org/wiki/API:Links | API:Links ]] module to identify red links on a page. [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/issues/37 | View issue on Github ]]. | @Didicodes, @Supriyasupu | @jeropbrenda
2. Pick an API page to work on and add your Phabricator username next to it in the relevant column:
| API page | Work in progress | Done
| [[ https://www.mediawiki.org/wiki/API:Block | API:Block ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Emailuser | API:Emailuser ]] | @SilkyPriya |
| [[ https://www.mediawiki.org/wiki/API:Options | API:Options ]] | @Areefa |
| [[ https://www.mediawiki.org/wiki/API:Logevents | API:Logevents ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Blocks | API:Blocks ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Recentchanges | API:Recentchanges ]] |@Oragonics | @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Embeddedin | API:Embeddedin ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Exturlusage | API:Exturlusage ]] | @Olena23 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @Manvigupta7 |
| [[ https://www.mediawiki.org/wiki/API:SetPageLanguage | API:SetPageLanguage ]] || @Nikitrain
| [[ https://www.mediawiki.org/wiki/API:Deletedrevs | API:Deletedrevs ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Querypage | API:Querypage ]] || @jeropbrenda
| [[ https://www.mediawiki.org/wiki/API:Allrevisions | API:Allrevisions ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Compare | API:Compare ]] | @Abhism9450 |
| [[ https://www.mediawiki.org/wiki/API:Upload | API:Upload ]] | @Mansi29ag |
| [[ https://www.mediawiki.org/wiki/API:Import | API:Import ]] | @shruthishridhar |
| [[ https://www.mediawiki.org/wiki/API:Rollback | API:Rollback ]] | @Didicodes |
| [[ https://www.mediawiki.org/wiki/API:Protect | API:Protect ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Tags | API:Tags ]] | @Edisonabah |
| [[ https://www.mediawiki.org/wiki/API:Categoryinfo | API:Categoryinfo ]] | @Eisheeta |
| [[ https://www.mediawiki.org/wiki/API:Langlinks | API:Langlinks ]] | @supriyasupu |
| [[ https://www.mediawiki.org/wiki/API:Allfileusages | API:Allfileusages ]] | @Nikitrain|
| [[ https://www.mediawiki.org/wiki/API:Iwlinks | API:Iwlinks ]] | @Hasinifoss |
| [[ https://www.mediawiki.org/wiki/API:Pagepropnames | API:Pagepropnames ]] | @Didicodes|
| [[ https://www.mediawiki.org/wiki/API:Watchlist | API:Watchlist ]] | @SilkyPriya @Nimbus20 |
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] | @dave_oh |
| [[ https://www.mediawiki.org/wiki/API:Account creation | API:Account creation ]] | @Arrsquare |
====Getting started instructions for third microtask====
- Set up [[ https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | Git ]] on your computer and a [[ https://github.com/ | Github account ]] if you don’t already have one. Learn how to use both.
- Set up a [[ https://www.mediawiki.org/wiki/MediaWiki | MediaWiki account ]] if you don’t already have one.
- Read the project description thoroughly and the [[ https://www.mediawiki.org/wiki/API:Main_page | MediaWiki Action API ]] too.
- Pick an action page from the table above that you would like to review and improve. Add your name next to the project in the “Work in progress” column. You will need to be logged into Phabricator and subscribed to the task and only then you will be able to edit the task description
- Create a page in your Sandbox (https://www.mediawiki.org/wiki/User:your_username/Sandbox/API:pagename) and do not make edits directly to the API pages.
- Fill it with the template content which is in here: https://www.mediawiki.org/wiki/API:Documentation_template (copy and paste). We encourage you to stick to the template if for some reason you feel the urge to add or remove any section, discuss with your mentors.
- For your reference, read a couple recent API pages that we modified using the new template: [[ https://www.mediawiki.org/wiki/API:Geosearch | API:Geosearch ]], [[ https://www.mediawiki.org/wiki/API:Parsing_wikitext | API:Parsing_wikitext ]]
- Contribute sample code for the API page to this repository: https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples. Please read the [[ https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples#contributing-code-samples | contribution guidelines ]] before starting to work on a topic.
- When you are done, ping @srishakatux on Zulip and get some feedback on your work.
- Incorporate feedback. Once you get a green signal, coordinate with mentors in getting your changes integrated with the actual page on MediaWiki.org.
- Finally, add your name next to the project in the “Done” column in the table above.
====Mentor(s)====
@Srishakatux @srodlund
====Get in touch with mentors====
Ask a question in the topic `Phab:T215682 API documentation improvements` under https://wikimedia.zulipchat.com/#narrow/stream/180873-gsoc19-outreachy18
==== Resources ====
* How to use or write Templates https://www.mediawiki.org/wiki/Help:Templates
* Page translation https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example
* Editing wiki pages https://www.mediawiki.org/wiki/Help:Editing
* Learn how to use Phabricator https://www.mediawiki.org/wiki/Phabricator/Help