1411317 - Build documentation should be moved in-tree.

Status: RESOLVED WONTFIX

(Developer Documentation Graveyard :: Mozilla Platform, enhancement, P5)

Description

[Tooru Fujisawa [:arai]]

Some time ago, build documentation is splitted into each OS, combined with prerequisites page.

https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build

https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Windows_Prerequisites
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Mac_OS_X_Prerequisites
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build/Linux_and_MacOS_build_preparation

and now some steps are totally out of sync even if they're saying essentially same thing.
when some change happens there (like, bootstrap.py behavior changes), people needs to update 3 pages, with same content, but in different context or scenario,
that's very unfortunate and tends to make the content obsolete.

I'd propose merging them again, at least in term of content management.
if it's better presenting the whole steps in single page, we can embed common steps into OS-specific page, with {{page}} macro.

Comment 1

[Tooru Fujisawa [:arai]]

mhoye, can I have your opinion?
(ni?-ing you because I see your name in history of the page around the structure change. sorry if it wasn't you)

what I'm thinking is doing either:
  A. revert back to original state, that is:
       * single clone and build documentation
       * prerequisites pages for each OS
  B. share common content and manage it in single place, that is:
       * move clone/build documentation content into sub page (that is not linked directory form anywhere)
       * embed the sub page into each OS's page, with {{page}} macro

Comment 2

[Mike Hoye [:mhoye]]

So, I do have an update on this, and that update is: This stuff should be moved off MDN and into m-c in some format that we can export to readthedocs.

This is my responsibility, I think, and I'm sorry I haven't gotten to it yet.

Comment 3

[Janet Swisher]

The MDN team is no longer actively working on Mozilla Platform docs. Volunteer contributions are welcome.

Comment 4

[BMO Automation]

MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.