Bug 1594925 - Follow up on the doc documentation r=ahal
authorSylvestre Ledru <sledru@mozilla.com>
Mon, 18 Nov 2019 21:12:51 +0000
changeset 502498 93c199bb39288eb84cec5d26723a400263000f59
parent 502497 859e84396f6dc4584bbb0d53be2756c26ca78ea0
child 502499 7f64e4879257aefc6450321a66532576ca29079b
push id100875
push usersledru@mozilla.com
push dateMon, 18 Nov 2019 21:23:42 +0000
treeherderautoland@93c199bb3928 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersahal
bugs1594925
milestone72.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1594925 - Follow up on the doc documentation r=ahal Differential Revision: https://phabricator.services.mozilla.com/D53395
tools/docs/docs/index.rst
tools/docs/docs/mdn-import.rst
--- a/tools/docs/docs/index.rst
+++ b/tools/docs/docs/index.rst
@@ -2,17 +2,17 @@ Managing Documentation
 ======================
 
 This documentation is generated via the
 `Sphinx <http://sphinx-doc.org/>`_ tool from sources in the tree.
 
 To build the documentation, run ``mach doc``. Run
 ``mach help doc`` to see configurable options.
 
-MDN should not be used for Firefox/Gecko processes or source code
-documentation.
+This is the preferred location for all Firefox development process and
+source code documentation.
 
 .. toctree::
   :caption: Documentation
   :maxdepth: 2
   :glob:
 
   *
--- a/tools/docs/docs/mdn-import.rst
+++ b/tools/docs/docs/mdn-import.rst
@@ -1,11 +1,14 @@
 Importing documentation from MDN
 --------------------------------
 
+As MDN should not be used for documenting mozilla-central specific code or process,
+the documentation should be migrated in this repository.
+
 Fortunatelly, there is an easy way to import the doc from MDN
 to the firefox source docs.
 
 1. Install https://pandoc.org/
 
 2. Add a ``?raw=1`` add the end of the MDN URL
 
 3. Run pandoc the following way: