Page MenuHomePhabricator

Write inline documentation
Closed, ResolvedPublic

Description

PAWS pages need lots of documentation. https://tools.wmflabs.org/paws should give an overview of the project and some examples of what you can do. The next page should explain what will happen when you create a new server. The server main menu should include docs that explain what it means to create a new Python notebook, and so on.

See also: T129548: Documentation for PAWS

Event Timeline

awight raised the priority of this task from to Needs Triage.
awight updated the task description. (Show Details)
awight added subscribers: awight, yuvipanda.

Keeping this on the radar -- but noting that Jupyter notebooks have excellent documentation, so unless we are documenting functions specific to Wikimedia projects, there is no need to write general notebook documentation. This can be found here: https://jupyter-notebook.readthedocs.io/en/stable/

@srodlund aptly directs to the documentation for jupyter. Which should contain most of the documentation that is needed for how to run jupyter. PAWS specific documentation can be found https://wikitech.wikimedia.org/wiki/PAWS