1605742 - Instructions on how to build and contribute to Firefox should move here from MDN

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, task, P3)

Description

[Ethan Glasser-Camp (:glasserc)]

Currently a lot of the documentation incidental to the work of developing Firefox is in MDN. For example, the readme.txt in Mercurial says to consult https://developer.mozilla.org/en/Mozilla_Source_Code_Directory_Structure, https://developer.mozilla.org/en/docs/Build_Documentation, https://developer.mozilla.org/en/docs/Creating_a_patch, and https://developer.mozilla.org/en/docs/Getting_your_patch_in_the_tree.

Now that MDN is shifting focus to documenting only web technologies, this is no longer a good home for those docs. Indeed, it's no longer possible to find the above-linked pages from the front page of MDN. Additionally, the "distance" between the code and the documentation may hinder keeping the two in sync.

I'd like to propose moving the above documentation and some of the linked stuff into the in-repository documentation. This documentation can be surfaced on the front page of firefox-source-docs under a heading called Contributing, and the links in readme.txt can be replaced with the filenames of the relevant documentation.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

Yes, we need to make progress on that. It is now more a matter of who does the grunt work.

Note that we have this page:
https://firefox-source-docs.mozilla.org/tools/docs/contribute/how_to_contribute_firefox.html

And we have some docs to import from MDN:
https://firefox-source-docs.mozilla.org/tools/docs/mdn-import.html

Comment 2

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1605742 - Move Mozilla Source Code Directory Structure docs into firefox. r=sylvestre,ahal

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c45c4249427a
Move Mozilla Source Code Directory Structure docs into firefox. r=sylvestre

Comment 4

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1605742 - Refresh of the doc r?championshuttler

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e1e775717e3d
Refresh of the doc r=championshuttler

Comment 6

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1605742 - Ride along update the README. r=sylvestre

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f5b3a0b61735
Ride along update the README. r=sylvestre

Comment 8

[Alexandru Michis [:malexandru]]

https://hg.mozilla.org/mozilla-central/rev/c45c4249427a

Comment 9

[Sylvestre Ledru [:Sylvestre]]

Much more have to land

Comment 10

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/e1e775717e3d
https://hg.mozilla.org/mozilla-central/rev/f5b3a0b61735

Comment 11

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1605742 - Add Page for Mercurial.r=sylvestre

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8891c1aa0d7c
Add Page for Mercurial.r=sylvestre

Comment 13

[Andrei Ciure[:aciure]]

Backed out changeset 8891c1aa0d7c (bug 1605742) at sylvestre's request

https://hg.mozilla.org/integration/autoland/rev/ab1bd22d87c7eab5e792cd8d3e8afd3ea01db503

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1450aea2593c
Add Page for Mercurial.r=sylvestre

Comment 15

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/1450aea2593c

Comment 16

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1605742 - Move Mercurial docs to docs/contributing directory.r=sylvestre

Comment 17

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a316e957c675
Move Mercurial docs to docs/contributing directory.r=sylvestre

Comment 18

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/a316e957c675