Welcome to Bedrock’s documentation!

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

bedrock is a web application based on Django, a Python web application framework.

Patches are welcome! Feel free to fork and contribute to this project on Github.

Contents

• Installing Bedrock
  • Installation Methods
  • Run the tests
  • Run a local server
  • Localization
  • Feature Flipping (aka Switches, or waffle switches)
• Localization
  • Fluent
  • All
  • About L10N integrations
• Developing on Bedrock
  • Managing Dependencies
  • Asset Management and Bundling
  • Writing JavaScript
  • Writing URL Patterns
  • Finding Templates by URL
  • Optimizing Images
  • Embedding Images
  • Using Large Assets
  • Writing Migrations
  • Writing Views
  • Metrics Collection with Markus
  • Coding Style
  • Test coverage
  • Configuring your Code Editor
  • Working with Protocol Design System
• How to contribute
  • Git workflow
  • Git commit messages
  • Submitting your work
  • Squashing your commits
  • Deploying your code
• Continuous Integration & Deployment
  • Deployed site URLs
  • Tests in the lifecycle of a change
  • What Is Currently Deployed?
  • Instance Configuration & Switches
  • Updating Selenium
  • Adding test runs
  • Pushing to the integration tests branch
• Front-end testing
  • Automating the browser
  • Running Jasmine tests
  • Running Playwright tests
  • Accessibility testing (Axe)
  • Running Selenium tests
  • Testing Basket email forms
• Managing Redirects
  • Add a redirect
  • Differences
  • Utilities
  • Testing redirects
• Newsletters
  • Features
  • Newsletters
  • Bedrock and Basket
  • URLs
  • Footer sign-up
• Contentful CMS Integration (Deprecated)
  • Overview
  • Contentful Apps
  • Content Models
  • Adding support for a new product icon, size, folder
  • Rich Text Rendering
  • L10N
  • Assets
  • Preview
  • Roles/Permissions
  • Development practices
  • Useful Contentful Docs
  • Assumptions we still need to deal with
  • Legacy
• CMS
  • High-level summary
  • Accessing the CMS on your local machine
  • Fetching the latest CMS data for local work
  • Adding new content surfaces
  • Editing current content surfaces
  • The CMS_ALLOWED_PAGE_MODELS setting
  • Migrating Django pages to the CMS
  • Generating URLs for CMS pages in non-CMS templates
  • Images
  • Page-tree concept
  • Locale configuration within Wagtail
  • Localization process
  • Infrastructure notes
• Sitemaps
  • Quick summary
• Legal Docs
  • Templates
• Using External Content Cards Data
  • Add to a View
  • Add to the Template
• Banners
  • Creating page banners
• Mozilla.UITour
  • Introduction
  • Local development
  • JavaScript API
• Task queue
• Send to Device Widget
  • Usage
• Firefox Download Buttons
  • Which button should I use?
  • Documentation
• Mozilla accounts helpers
  • Mozilla account sign-up form
  • Mozilla account links
  • Mozilla Monitor links
  • Pocket links
  • Common Parameters
  • Mozilla VPN Links
  • Firefox Sync and UITour
  • Testing Sign-up Flows
• A/B Testing
  • Traffic Cop experiments
  • Avoiding experiment collisions
• Mozilla VPN Subscriptions
  • Server architecture
  • Adding new countries for VPN
  • Excluded countries
• Attribution
  • Mozorg analytics
  • Firefox desktop attribution
  • Firefox mobile attribution
  • Mozilla accounts attribution
  • Mozilla CJMS affiliate attribution
  • Managing Data Privacy and Consent
• Architectural Decision Records
  • 1. Record architecture decisions
  • 2. Move CI/CD Pipelines to Gitlab
  • 3. Use Cloudflare Workers and Convert for multi-variant testing
  • 4. Use Fluent For Localization
  • 5. Use a Single Docker Image For All Deployments
  • 6. Revise tooling for Python dependency management
  • 7. Further revise tooling for Python dependency management
  • 8. Move Demos To GCP
  • 9. Manage Contentful schema state via migrations
  • 10. Move CI to Github Actions for Unit and Integration tests
  • 11. Use StatsD for metrics collection
  • 12. Use Wagtail as Bedrock’s CMS
• Browser Support
  • Browser Support Matrix
  • Delivering basic support
  • Delivering degraded support
  • Exceptions (Updated 2019-06-11)