MDN/Archives/Documentation automation tool: Difference between revisions

MDN/Archives/Documentation automation tool (view source)

1,124 bytes added , 17 December 2014

m

canmove, Confirmed users

1,953

edits

@@ Line 8: / Line 8: @@
 ==Patch generation and submission==
 Once editing is finished, a single button (with a Bugzilla login) should let you generate and submit a patch. This should include a human-written summary of the patch, with the patch itself and a link to preview what the docs will look like on MDN.
+==Questions==
+* How will translations fit into this tool?
+** Do we forgo translations of references and rely on translated how-to guides instead?
+** Or do we allow translations but have them continue to be a manual process based off automatically-generated English references?
+* How to keep the process simple, make it easy for people to contribute?
+* Do we continue to document removed methods etc as we currently do?
+** If so how will the tool manage this?
+** It would probably be easiest to just generate documentation for each Gecko version individually and the site would allow selecting the Gecko version to view, and possibly a diff between versions.
+* Should examples and other information that is not included in source files be included on the page, or as a separate page?
+* How will bug spaming be prevented?
+** Each page could have a bug number associated with it, so that a new bug is not generated each edit.
+** Should patches be 'batched', that is:
+*** A patch is generated once per day;
+*** X hours after last edit;
+*** After editorial review
+*** How about separate "save draft" and "submit patch" buttons?