Documentation improvements (tracking)
Closed, ResolvedPublic
Actions

Description

We are making an effort to improve documentation of service-related infrastructure. This task is used to track dependencies and progress.

Related Objects
Search...

Status	Assigned	Task
Resolved	• GWicke	T144814 Services Team Goals 2016/2017 Q2: October - December
Resolved	mobrovac	T136942 Services Team Goals July - September 2016 (Q1 2016-17)
Resolved	mobrovac	T118871 Services team goals April - June 2016 (Q4 2015/16)
Resolved	None	T118868 Services team goals January - March 2016 (Q3 2015/16)
Resolved	• GWicke	T128392 Documentation improvements (tracking)
Declined	None	T124987 Improve documentation / streamline process for people upgrading from shared hosting to mediawiki-containers
Resolved	Pchelolo	T125412 Documentation handling improvements
Resolved	mobrovac	T76309 Update citoid documentation on wikitech
Resolved	None	T97035 Index the API endpoints at …/wiki/api/ somehow
Resolved	Pchelolo	T128415 Set up documentation for errors, and link to it in problem URLs instead of old restbase.org default
Resolved	• GWicke	T128609 RFC: Update profile URLs in content types to point to format documentation
Resolved	• GWicke	T125254 Stabilize API end points
Resolved	• GWicke	T124365 RFC: Define a policy for REST API result format versioning / negotiation
Resolved	Pchelolo	T128040 Document and implement the REST API format versioning and negotiation policy
Open	None	T114413 Support various conversions in Parsoid's pb2pb endpoint
Resolved	Arlolra	T202666 html2wt endpoint should handle mismatching content versions
Resolved	Pchelolo	T202682 Improve Accept header normalization in VCL for REST API
Resolved	mobrovac	T130718 Enhance service deployment documentation

Event Timeline

• GWicke created this task.Feb 29 2016, 6:56 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 29 2016, 6:56 PM

• GWicke added a subtask: T124987: Improve documentation / streamline process for people upgrading from shared hosting to mediawiki-containers.Feb 29 2016, 6:56 PM

• GWicke updated the task description. (Show Details)

• GWicke added subtasks: T125412: Documentation handling improvements, T76309: Update citoid documentation on wikitech, T128040: Document and implement the REST API format versioning and negotiation policy.Feb 29 2016, 7:00 PM

• GWicke mentioned this in T118868: Services team goals January - March 2016 (Q3 2015/16).

• GWicke added a subtask: T97035: Index the API endpoints at …/wiki/api/ somehow.Feb 29 2016, 7:05 PM

• GWicke added a subtask: T128415: Set up documentation for errors, and link to it in problem URLs instead of old restbase.org default.Feb 29 2016, 10:04 PM

• GWicke added a subtask: T128609: RFC: Update profile URLs in content types to point to format documentation.Mar 2 2016, 5:02 PM

• GWicke closed subtask T97035: Index the API endpoints at …/wiki/api/ somehow as Resolved.Mar 2 2016, 5:19 PM

• GWicke added a subtask: T125254: Stabilize API end points.Mar 22 2016, 2:53 PM

mobrovac added a subtask: T130718: Enhance service deployment documentation.Mar 23 2016, 2:31 PM

We have settled for mw:Documentation/Services as the main doc index.

Work division from our planning meeting:

@mobrovac

Create documentation index
working on docs for general service set-up and deployment: https://wikitech.wikimedia.org/wiki/User:Mobrovac/My_Guide_To_The_Galaxy

T125254: Stabilize API end points
Expand on API versioning documentation: T128040: Document and implement the REST API format versioning and negotiation policy
T128609: RFC: Update profile URLs in content types to point to format documentation
If there is extra time: T124987: Improve documentation / streamline process for people upgrading from shared hosting to mediawiki-containers