Page MenuHomePhabricator

Improvements to Action API tutorials
Open, Needs TriagePublic

Description

Based on the findings in T307014 make the following improvements to Action API pages listed below.

For API:Holidays viewer:

  • Improve the flow of steps. Make sure that completing a step results in a working application (no errors, produces expected output).
  • Make sure it's clear what dependencies need to be installed and imported and when, and what is the value added by every dependency.

For API:Picture of the day viewer:

  • The Next steps section mentions action=cirrusdump, with a link to an example that probably does not work. Consider providing a working example or linking to Extension:CirrusSearch or similar.
  • The app demo on Toolforge exhibits a strange behavior - when pressing Back or Next, it does not change the date by one, but actually moves to a seemingly random date. This is probably because the current date is stored in a global variable - it's essentially state shared between multiple users. I assume that if two or more users click buttons, the current date will change by more than one for at least one of them. Investigate whether we should fix this.
  • The app demo on Toolforge gives a 500 error.
  • There are discrepancies between the code on the wiki page and in the GitHub repository.

For API:Article ideas generator:

  • There is a bit of a leap between the last step of the tutorial and the final outcome in terms of styling and behavior of the application. Make sure that the outcome of the last step is the same application as the one in the final examples.
  • Code added in step 4 breaks the application. Readers need to continue with code from step 5 to fix it. Consider merging these steps or splitting them differently.
  • Check if the application works correctly. If you go to Social sciences and then Genealogy, you will get the same ideas as in Social sciences - Other social and cultural issues, despite differences on the relevant wiki page. Investigate whether we should fix this.

Related Objects

Event Timeline

KBach updated the task description. (Show Details)
KBach updated the task description. (Show Details)

@RhinosF1: This has nothing to do with the MediaWiki-Action-API codebase...

All the pages referred to say they're part of the action API docs. Sorry if that's me misunderstanding and feel free replace with better tags.