I think we should question the assumption that writing source-code-level documentation is a good activity for newcomers to the codebase.
Documentation is usually best written by someone with a deep understanding of what is being documented, not by someone new to the project. And this documentation is developer-focused, meaning anyone understanding its content deeply should generally be an experienced developer. At the most, I can see using a documentation edit as an exercise in going through the patch / review / land process for a contributor who I would then urge on to more substantive tasks (which may also involve substantive doc updates). All of which is to say, yes, I'd like to see the numbers on this and I think we should use those numbers to think carefully about whether the proposal merits the cost in complexity, implementation time, and security risk. Dustin 2017-10-19 13:13 GMT-04:00 Andreas Tolfsen <a...@sny.no>: > Also sprach Sylvestre Ledru: > >> By the way, do we know how many mdn contributions are made on >> these pages by people who are not regular Firefox developers? A >> push in-tree requires permissions, which isn't a small barrier, >> might impact that (not mentioning the size of the repo). If this >> is only a few people, this might not be an issue. > > > I don’t have these numbers, but gps had some thoughts on how > to potentially allow on-line GitHub editing PRs to m-c for > below-commit-level-3 changes that you can read more about in the > other thread [1]. Perhaps that is a way to make drive-by community > contributions to in-tree documentation easier. > > My primary concern is to first fix the papercut of having to channel > changes to existing in-tree documentation through the same review > process as regular source code. > > [1] > https://groups.google.com/d/msg/mozilla.dev.builds/cp4bJ1QJXTE/MQUHhqX-DAAJ > > _______________________________________________ > dev-builds mailing list > dev-bui...@lists.mozilla.org > https://lists.mozilla.org/listinfo/dev-builds _______________________________________________ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform
