Bug 1606026: Move existing documentation into new locations r=sylvestre
authorEthan Glasser-Camp <eglassercamp@mozilla.com>
Mon, 06 Jan 2020 16:38:34 +0000
changeset 508928 d03b5479fab3073cdd0759f459e271447db4ff82
parent 508927 f7974eae3d6404f81c645dc072909d28738e33e1
child 508929 f6ce57edcf0de68cb9652fcde1fb76a780a9e1ff
push id36986
push usernerli@mozilla.com
push dateMon, 06 Jan 2020 21:54:03 +0000
treeherdermozilla-central@e6427fac5ee8 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerssylvestre
bugs1606026
milestone73.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 1606026: Move existing documentation into new locations r=sylvestre Differential Revision: https://phabricator.services.mozilla.com/D58338
README.txt
build/sparse-profiles/sphinx-docs
docs/config.yml
docs/contributing/directory_structure.rst
docs/contributing/how_to_contribute_firefox.rst
docs/contributing/index.rst
docs/index.rst
moz.build
tools/docs/docs/adding-documentation.rst
tools/docs/docs/contribute/how_to_contribute_firefox.rst
tools/docs/docs/contribute/mozilla_source_code_directory_structure.rst
tools/docs/docs/index.rst
tools/docs/docs/mdn-import.rst
tools/lint/codespell.yml
tools/moz.build
tools/moztreedocs/docs/adding-documentation.rst
tools/moztreedocs/docs/index.rst
tools/moztreedocs/docs/mdn-import.rst
--- a/README.txt
+++ b/README.txt
@@ -1,16 +1,16 @@
 An explanation of the Mozilla Source Code Directory Structure and links to
 project pages with documentation can be found at:
 
-    https://firefox-source-docs.mozilla.org/tools/docs/contribute/mozilla_source_code_directory_structure.html
+    https://firefox-source-docs.mozilla.org/contributing/directory_structure.html
 
 For information on how to build Mozilla from the source code and create the patch see:
 
-    https://firefox-source-docs.mozilla.org/tools/docs/contribute/how_to_contribute_firefox.html
+    https://firefox-source-docs.mozilla.org/contributing/how_to_contribute_firefox.html
 
 If you have a question about developing Mozilla, and can't find the solution
 on https://developer.mozilla.org, you can try asking your question on IRC at irc.mozilla.org in #introduction channel.
 
 Nightly development builds can be downloaded from:
 
     https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central/
             - or -
--- a/build/sparse-profiles/sphinx-docs
+++ b/build/sparse-profiles/sphinx-docs
@@ -1,14 +1,13 @@
 %include build/sparse-profiles/mach
 
 [include]
 # Code for generating docs.
 glob:docs/**
-glob:tools/docs/**
 glob:tools/moztreedocs/**
 
 # Potential docs sources
 glob:**/*.rst
 glob:**/*.md
 glob:**/*.js
 glob:**/*.jsm
 
--- a/docs/config.yml
+++ b/docs/config.yml
@@ -1,13 +1,15 @@
 ---
 
 # The order of the main categories are defined in index.rst
 # Sub categories orders are preserved
 categories:
+    contributing_doc:
+        - contributing
     source_doc:
         - browser
         - dom
         - gfx
         - devtools
         - toolkit
         - js
         - mobile/android/geckoview
@@ -16,17 +18,17 @@ categories:
         - remote
         - services/common/services
         - uriloader
     build_doc:
         - mach
         - tools/try
         - build/buildsystem
         - taskcluster
-        - tools/docs
+        - tools/moztreedocs
     testing_doc:
         - testing/marionette
         - testing/geckodriver
         - web-platform
         - tools/fuzzing
     code_quality_doc:
         - tools/lint
         - tools/static-analysis
@@ -47,8 +49,9 @@ redirects:
     modules/libpref/libpref: modules/libpref
     python/mach: mach
     python/python: python
     taskcluster/taskcluster: taskcluster
     testing/geckodriver/geckodriver: testing/geckodriver
     testing/marionette/marionette: testing/marionette
     toolkit/components/telemetry/telemetry: toolkit/components/telemetry
     tools/compare-locales/index.html: build/buildsystem/locales.html
+    tools/docs/index.html: tools/moztreedocs/index.html
rename from tools/docs/docs/contribute/mozilla_source_code_directory_structure.rst
rename to docs/contributing/directory_structure.rst
rename from tools/docs/docs/contribute/how_to_contribute_firefox.rst
rename to docs/contributing/how_to_contribute_firefox.rst
new file mode 100644
--- /dev/null
+++ b/docs/contributing/index.rst
@@ -0,0 +1,11 @@
+Contributing to Firefox
+=======================
+
+This is the preferred location for all Firefox development process and
+source code documentation.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   *
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,19 @@
 =================================
 Mozilla Source Tree Documentation
 =================================
 
 .. toctree::
+   :caption: Contributing
+   :maxdepth: 2
+
+   {contributing_doc}
+
+.. toctree::
    :caption: Source code doc
    :maxdepth: 2
 
    {source_doc}
 
 
 .. toctree::
    :caption: Build
--- a/moz.build
+++ b/moz.build
@@ -168,9 +168,11 @@ if CONFIG['MOZ_BUILD_APP']:
     include('/' + CONFIG['MOZ_BUILD_APP'] + '/app.mozbuild')
 else:
     include('/toolkit/toolkit.mozbuild')
 
 OBJDIR_PP_FILES['.cargo'] += ['.cargo/config.in']
 
 DEFINES['top_srcdir'] = TOPSRCDIR
 
+SPHINX_TREES['contributing'] = 'docs/contributing'
+
 include('build/templates.mozbuild')
--- a/tools/lint/codespell.yml
+++ b/tools/lint/codespell.yml
@@ -45,17 +45,16 @@ codespell:
         - toolkit/components/extensions/docs/
         - toolkit/components/normandy/docs/
         - toolkit/components/search/docs/
         - toolkit/components/telemetry/docs/
         - toolkit/crashreporter/docs/
         - toolkit/docs/
         - toolkit/locales/en-US/
         - toolkit/modules/docs/
-        - tools/docs/
         - tools/moztreedocs/
         - tools/lint/
         - tools/tryselect/
     exclude:
         - tools/lint/test/test_codespell.py
     # List of extensions coming from:
     # tools/lint/{flake8,eslint}.yml
     # tools/mach_commands.py (clang-format)
--- a/tools/moz.build
+++ b/tools/moz.build
@@ -11,20 +11,16 @@ with Files("code-coverage/**"):
     BUG_COMPONENT = ("Testing", "Code Coverage")
 
 with Files("compare-locales/mach_commands.py"):
     BUG_COMPONENT = ("Localization Infrastructure and Tools", "compare-locales")
 
 with Files("coverity/**"):
     BUG_COMPONENT = ("Firefox Build System", "Source Code Analysis")
 
-with Files("docs/**"):
-    BUG_COMPONENT = ("Firefox Build System", "Generated Documentation")
-    SCHEDULES.exclusive = ['docs']
-
 with Files("github-sync/**"):
     BUG_COMPONENT = ("Core", "Graphics")
 
 with Files("lint/**"):
     BUG_COMPONENT = ("Firefox Build System", "Lint and Formatting")
 
 with Files("moztreedocs/**"):
     BUG_COMPONENT = ("Firefox Build System", "Generated Documentation")
@@ -54,23 +50,23 @@ with Files("tryselect/selectors/release.
 with Files("update-packaging/**"):
     BUG_COMPONENT = ("Release Engineering", "General")
 
 with Files("update-verify/**"):
     BUG_COMPONENT = ("Release Engineering", "Release Automation: Updates")
 
 SPHINX_TREES['lint'] = 'lint/docs'
 
+SPHINX_TREES['moztreedocs'] = 'moztreedocs/docs'
+
 with Files('lint/docs/**'):
     SCHEDULES.exclusive = ['docs']
 
 SPHINX_TREES['try'] = 'tryselect/docs'
 
-SPHINX_TREES['docs'] = 'docs/docs'
-
 SPHINX_TREES['static-analysis'] = 'clang-tidy/docs'
 
 SPHINX_TREES['fuzzing'] = 'fuzzing/docs'
 
 with Files('tryselect/docs/**'):
     SCHEDULES.exclusive = ['docs']
 
 CRAMTEST_MANIFESTS += [
rename from tools/docs/docs/adding-documentation.rst
rename to tools/moztreedocs/docs/adding-documentation.rst
rename from tools/docs/docs/index.rst
rename to tools/moztreedocs/docs/index.rst
--- a/tools/docs/docs/index.rst
+++ b/tools/moztreedocs/docs/index.rst
@@ -8,17 +8,14 @@ code that it documents, so it can be upd
 the underlying changes.
 
 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.
 
-This is the preferred location for all Firefox development process and
-source code documentation.
-
 .. toctree::
   :caption: Documentation
   :maxdepth: 2
   :glob:
 
   *
rename from tools/docs/docs/mdn-import.rst
rename to tools/moztreedocs/docs/mdn-import.rst