releng docs
Перейти к файлу
Heitor Neiva b3a2fb848f
PR nits on mobile automation
2022-10-13 10:06:31 -07:00
addons Refactoring 2021-09-14 19:14:22 +01:00
architecture fix nits 2015-05-29 16:27:42 -04:00
balrog Add link to main Balrog docs 2020-04-27 12:59:35 -04:00
best-practices cross-training (#65) 2020-09-28 10:03:03 -07:00
future Spelling fixes 2020-04-14 15:16:20 +01:00
gecko_tests fix warnings + green up rtd build (#98) 2021-09-17 09:20:58 -07:00
logs fix logs links 2021-10-27 17:28:44 -06:00
procedures PR nits on mobile automation 2022-10-13 10:06:31 -07:00
signing review comment + a bit more dep explanation 2021-10-28 09:10:21 -06:00
taskcluster Release promotion: testing and launching custom variants (#109) 2021-10-12 08:46:43 -07:00
.gitignore Release promotion: testing and launching custom variants (#109) 2021-10-12 08:46:43 -07:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-27 21:21:12 -07:00
Makefile Support sphinx 3. (#19) 2020-04-10 14:25:49 -07:00
README Make some corrections in other docs 2021-08-27 12:12:41 +01:00
adding_docs_to_existing_code.rst Spelling fixes 2020-04-14 15:16:20 +01:00
adding_repo_to_releng_rtfd_account.rst update domain to readthedocs.io 2016-04-27 16:30:56 -07:00
conf.py Fix sphinx errors 2021-09-27 16:47:10 -04:00
hosts.rst Now in Sphinx format. 2013-11-19 15:54:28 -05:00
index.rst Add links to various logs and errors, and how to get access to them 2021-10-19 14:49:56 -04:00
machine-users.rst Add docs for our mercurial machine users. (#38) 2020-08-24 13:35:26 -07:00
maintaining_these_docs.rst Make some corrections in other docs 2021-08-27 12:12:41 +01:00
make.bat Support sphinx 3. (#19) 2020-04-10 14:25:49 -07:00
releng_changelog.md Update releng_changelog.md 2021-10-26 15:59:44 -07:00
releng_wordlist.txt Update wordlist 2020-06-15 18:32:20 +01:00
rtfd-requirements.in fix warnings + green up rtd build (#98) 2021-09-17 09:20:58 -07:00
rtfd-requirements.txt fix warnings + green up rtd build (#98) 2021-09-17 09:20:58 -07:00
software.rst fix dup taskcluster labels 2020-08-28 12:54:34 -07:00
tobewritten.rst Switch to "todo" blocks for missing content. 2014-05-16 15:49:51 -07:00
troubleshooting.rst fix errors (#100) 2021-09-22 08:00:57 -07:00

README

This repository has some of the more technical, and volatile internal
documentation for Firefox Release Engineering.

Rendered versions of the documentation may be viewed at:
  http://moz-releng-docs.readthedocs.io/en/latest/

1. Create a python virtualenv

2. ``pip install -r rtfd-requirements.txt``

3. ``make html`` will build the docs locally and confirm that nothing in the toctree is broken. 
Verify any changes by viewing _build/html/index.html

Note: Any new docs should be directly or indirectly linked to from index.rst. (For example, if index.rst contains balrog/index.rst in its toctree, and the new doc is in the balrog/index.rst toctree, then the new doc is successfully indirectly linked.)