blob: 69d2f56df4082148f8728789c845d0c3bd0da7e4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
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.
The meta bug is `Bug 1617963 <https://bugzilla.mozilla.org/show_bug.cgi?id=migrate-from-mdn>`__.
Fortunately, there is an easy way to import the doc from MDN using GitHub
to the firefox source docs.
1. Install https://pandoc.org/ - If you are using packages provided by your distribution,
make sure that the version is not too old.
2. Identify where your page is located on the GitHub repository ( https://github.com/mdn/archived-content/tree/main/files/en-us/mozilla ).
Get the raw URL
3. Run pandoc the following way:
.. code-block:: shell
$ pandoc -t rst https://github.com/mdn/archived-content/tree/main/files/en-us/mozilla/firefox/performance_best_practices_for_firefox_fe_engineers > doc.rst
4. In the new doc.rst, identify the images and wget/curl them into `img/`.
5. Verify the rst syntax using `./mach lint -l rst`_
.. _./mach lint -l rst: /tools/lint/linters/rstlinter.html
6. If relevant, remove unbreakable spaces (rendered with a "!" on Phabricator)
.. code-block:: shell
$ sed -i -e 's/\xc2\xa0/ /g' doc.rst
|
