Page MenuHomePhabricator

Create an advanced tutorial for OOUI
Closed, DeclinedPublic

Description

There should be a tutorial that shows how to create a larger-scale application with OOUI.

Possible Topics:

  • Using the Model-View-Controller Pattern
  • Unidirectional data flow
  • Testing the Application and its components with QUnit
  • Single Responsibility Principle

Open issues from patch (PS 4):

  • Move/Refactor snippets to use module syntax (Tutorial.Advanced1.Version1.TodoController) instead of numbered class versions. This will fix the remaining eslint errors and enable ...
  • Automatically inserting source code in tutorial HTML. We could create a Grunt string-replace configuration that looks for markers (containing file names and line numbers) in the HTML file and inserts file contents in the HTML.
  • Better guidance for the readers, which files to create/change, so they can follow along as an interactive tutorial.
  • Expand the text in the introduction and summary section.
  • Add the HTML file to navigational links/menus in footer and header of all tutorial HTML files
  • Proofreading and editing.

Event Timeline

Change 511103 had a related patch set uploaded (by Gabriel Birke; owner: Gabriel Birke):
[oojs/ui@master] Add tutorial for MVC TODO list

https://gerrit.wikimedia.org/r/511103

Trizek-WMF subscribed.

How this is impacting tools creators? Where those ressources are available?

When ready, please move it to "Announce in next Tech News" on the User-notice board.

The example code is now ready, but the pull request itself needs more work:

  • Move/Refactor snippets to use module syntax (Tutorial.Advanced1.Version1.TodoController) instead of numbered class versions. This will fix the remaining eslint errors and enable ...
  • Automatically inserting source code in tutorial HTML. We could create a Grunt string-replace configuration that looks for markers (containing file names and line numbers) in the HTML file and inserts file contents in the HTML.
  • Better guidance for the readers, which files to create/change, so they can follow along as an interactive tutorial.
  • Expand the text in the introduction and summary section.
  • Add the HTML file to navigational links/menus in footer and header of all tutorial HTML files
  • Proofreading and editing.

Don't know if I can continue working on it.

@gabriel-wmde: Does this still make sense given the move to Codex/Vue.js, or should this task and patch be abandoned?

Change #511103 abandoned by VolkerE:

[oojs/ui@master] tutorials: Add tutorial for MVC TODO list

Reason:

This is not going to be proceeded with now that Codex/Vue.js is our focus. Thanks again Gabriel Birke for all the great work so far. In case anyone would like to pick that up and finalize in an open source manner, they could reactivate this patch.

https://gerrit.wikimedia.org/r/511103

Volker_E subscribed.

Sadly for all the work provided by @gabriel-wmde, we won't proceed with this and focus our energies on Codex instead. Thanks nonetheless! <3