bedrock/docs/index.rst

.. This Source Code Form is subject to the terms of the Mozilla Public
.. License, v. 2.0. If a copy of the MPL was not distributed with this
.. file, You can obtain one at http://mozilla.org/MPL/2.0/.

=======================================
Welcome to Bedrock's documentation!
=======================================

**bedrock** is the project behind www.mozilla.org. It is as
shiny, awesome, and open-sourcy as always. Perhaps even a little more.

bedrock is a web application based on `Django
<http://www.djangoproject.com/>`_, a `Python <https://www.python.org>`_ web application framework.

Patches are welcome! Feel free to fork and contribute to this project on
`Github <https://github.com/mozilla/bedrock>`_.


Contents
--------

.. toctree::
   :maxdepth: 2

   install
   l10n
   fluent-conversion
   coding
   contribute
   pipeline
   testing
   redirects
   javascript-libs
   newsletters
   content-cards
   uitour
   send-to-device
   firefox-accounts
   funnelcake
   abtest
   analytics
   stub-attribution
   architectural-decisions
   browser-support
Update license to MPL 2. 2012-11-26 20:12:39 +04:00			`.. This Source Code Form is subject to the terms of the Mozilla Public`
			`.. License, v. 2.0. If a copy of the MPL was not distributed with this`
			`.. file, You can obtain one at http://mozilla.org/MPL/2.0/.`

Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00			`=======================================`
Update docs to reflect current reality * Add bootstrap.sh command and use in install docs 2018-03-30 18:25:50 +03:00			`Welcome to Bedrock's documentation!`
Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00			`=======================================`

Update docs to reflect current reality * Add bootstrap.sh command and use in install docs 2018-03-30 18:25:50 +03:00			`bedrock is the project behind www.mozilla.org. It is as`
			`shiny, awesome, and open-sourcy as always. Perhaps even a little more.`
Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00
added install docs 2012-01-10 03:52:31 +04:00			bedrock is a web application based on `Django
Update docs to reflect current reality * Add bootstrap.sh command and use in install docs 2018-03-30 18:25:50 +03:00			<http://www.djangoproject.com/>`_, a `Python <https://www.python.org>`_ web application framework.
Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00
			`Patches are welcome! Feel free to fork and contribute to this project on`
added install docs 2012-01-10 03:52:31 +04:00			`Github <https://github.com/mozilla/bedrock>`_.
Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00

			`Contents`
			`--------`

			`.. toctree::`
Cleanup docs - Fixes some errors - Replaces paraphrasing of the homepage with a 2-depths ToC - Links to the coding document bug 815144 2012-11-26 19:45:04 +04:00			`:maxdepth: 2`
Added a sphinx-based docs framework. 2011-06-04 00:55:06 +04:00
add install docs 2012-03-15 21:51:51 +04:00			`install`
Cleanup docs - Fixes some errors - Replaces paraphrasing of the homepage with a 2-depths ToC - Links to the coding document bug 815144 2012-11-26 19:45:04 +04:00			`l10n`
Add Fluent L10n system and port the Mission page to use it * Fix dict cache default timeout * Add fallback strings and checking for translations in template * Add ftl alias and ftl_lazy for use in py files * Move git repos and add fluent to l10n_update * Add percent_translated and required_messages to the l10n object * Add management commands for converting en-US .lang file and templates * Add command to convert en-US .lang file to .ftl file * Using data from above command add a command that will convert a template to use the .ftl strings * Update the l10n_update command to update both external l10n repos * Convert the /mission/ page to Fluent * Add command to convert .lang translations to .ftl * Copy en .ftl file when porting translations * Removes the original string hash comments as well. * Add Fluent docs. * Add indentation and key sorting to metadata JSON output * Add FTL file linting command * Update mission template for FTL and remove FTL specific template * Set l10n cache to 10s when DEBUG=True * Fix and add tests for get_l10n_path * Fix some style mistakes in docs and code * Support multiline group comments for required strings fix #7725, fix #7822, and fix #7726 2019-09-06 23:53:00 +03:00			`fluent-conversion`
Cleanup docs - Fixes some errors - Replaces paraphrasing of the homepage with a 2-depths ToC - Links to the coding document bug 815144 2012-11-26 19:45:04 +04:00			`coding`
Add documentation for Bedrock deployment pipeline configuration 2016-03-08 14:44:43 +03:00			`contribute`
			`pipeline`
[fix bug 1158842] Add front-end functional tests to bedrock using CasperJS 2015-04-27 14:19:02 +03:00			`testing`
Add documentation for Bedrock deployment pipeline configuration 2016-03-08 14:44:43 +03:00			`redirects`
Add docs for mozilla-accordion.js. Bug 1007717. - Add GA tracking for accordion collapse event. - Move ARIA from HTML to JS. - Refactor mozilla-accordion.less to rely on new (non-ARIA) HTML hooks. - Disallow direct child tabs - all accordion tabs/panels must be in a separate wrapper element. 2014-08-16 01:07:00 +04:00			`javascript-libs`
Port newsletter preferences to Bedrock - Create newsletter app and move hacks.mozilla.org.html there - Set up to display Django messages to the user. - Make displaying most of the information on the page conditional on having a formset, so we can still use the same template when some error occurs in processing. - Handle errors by displaying translated messages to the user. Also use Playdoh logging to log errors and debug information. - If no token given, or token is invalid, let user supply an email address and sign up for newsletters. 2013-02-21 19:30:39 +04:00			`newsletters`
Use external data for home page content cards This switches the current English home page to display content cards from data in the mozmeao/www-admin repo. Fix #6124 2018-12-14 00:32:35 +03:00			`content-cards`
[no bug] Update bedrock docs for Mozilla.UITour 2014-07-30 18:36:34 +04:00			`uitour`
[bug 1146982] Add 'Send to Device' macro 2015-04-09 17:01:37 +03:00			`send-to-device`
[fix bug 1244888] Add FxA / firstrun setup info to the bedrock documentation 2016-02-04 00:40:48 +03:00			`firefox-accounts`
Update docs on funnelcakes, analytics, and a/b tests (#6272) 2018-10-23 00:11:51 +03:00			`funnelcake`
Add a/b testing to docs 2018-08-09 18:51:11 +03:00			`abtest`
Add analytics page to Read The Docs 2016-06-23 20:13:58 +03:00			`analytics`
Make 'measuring installs' a repeatable, modular piece of code (Fixes #6871) (#6889) * Make 'measuring installs' a repeatable, modular piece of code (Fixes #6871) 2019-03-11 20:09:00 +03:00			`stub-attribution`
Add ADRs to Sphinx docs (#6692) * Install Sphinx markdown deps * Configure Sphinx with markdown support * Switch to RTD Sphinx theme for local too * Fix a bunch of Sphinx warnings for docs * Separate docs deps into a requirements file for RTD to use 2019-01-10 03:21:23 +03:00			`architectural-decisions`
Browser Support Page added Fixes #7389 2019-08-09 22:00:18 +03:00			`browser-support`