jodyheavener / fxa-ecosystem-platform

Firefox Ecosystem Platform Docs

This repo hosts the source code and tooling for the Firefox Ecosystem Platform documentation portal.

Scope and Target Audience

The docs in this repository are intended for engineers, designers or product managers working on applications in the Firefox Ecosystem.

Our aim is to help them understand how and why to incorporate Account-related features into their application, in a way that makes the Firefox family of products feel like a cohesive cross-app and cross-device experience for users.

Working on the Docs

The site is build using Docusaurus and is automatically deployed from master to GitHub Pages using CircleCI. To build and run it locally you can:

$> yarn
$> yarn start

That should open a new browser window automatically, or you can manually browse to http://localhost:3000/ecosystem-platform/ to view the docs. You can add and modify files under /docs to update the actual Markdown documentation, everything else is configuration and code for the site itself.

//////

• Developer Reference

  • Development setup
  • Release Process
  • Using VSCode with FxA

• FxA Services

  • Content server
    • Overview
    • Testing
  • Auth server
    • Overview
    • Testing
  • Profile server
    • Overview
    • Testing
  • GraphQL API
    • Overview
    • Testing

• Platform Concepts

  • Firefox Accounts
    • Overview – Integration with FxA – End-to-end Encryption – Metrics – Pairing authentication
  • Subscription Platform
    • Overview
    • Subscription Features
    • Integration with Subscription Platform
  • Firefox Push
    • Overview
    • Design, API's, Error Codes
    • Development Process
    • History
  • Firefox Sync
    • Overview
    • Password Management and Syncing
    • Bookmarks
    • Storage
    • History
    • Account Management
    • Becoming A Sync Client
    • Sync Testing
    • Using the Staging Environment