Minted Engineering Documentation

Different engineering teams and projects have different workflows and requirements for creating documentation. Subsequently, Minted documentation has dispersed into a variety of homes online.

At present, this (unofficial) page doesn’t seek to be comprehensive, but since you found it, we hope to provide some references to other documentation that might get you to what you’re looking for at Minted.

General Documentation

Here are some general places to look for Minted documentation online:

  • Minted Wiki - Company-wide documentation with lots of internal company information, technical documentation, style guidelines, etc. This is the primary, official source for learning about Minted.
  • Minted Docs Repo - Engineering documentation and technical designs for contributors that prefer the GH Markdown and pull request workflow.
  • GitHub project READMEs - For each repository in the Minted organization, check for a README file with documentation on the project.
  • eng-all@minted.com Mailing List - A whole lot of one-off RFCs, technical design documents, gotchas, and other information gets disseminated to the engineering mailing list.
  • Google Drive - Many RFCs, tech design documents, project specifications, and other documents are housed and searchable on Google Drive.
  • Box - People and strategy related documents and various training videos can often be found in the “pinned” folders on Box. Dig into the Engineering - Team folder to find even more engineering resources.

Project Documentation

Here’s a list of documentation resources for various projects we know about. Again, this isn’t authoritative or comprehensive, so keep digging around if you don’t find it here.

Fancyclothes

React components for community-designed websites (wedding websites).

Minted Monolith

Where the magic happens.

Giotto

WebGL-based image compositing engine.

Minted UI

React components for common Minted UI patterns.

Puppet

Making boxes talk and dance.

Waystone

The Minted image compositing API.

docs.mntd.net

The docs.mntd.net domain (where this page is hosted) is dedicated to serving static HTML documentation, the primary output format of some documentation tooling and workflows.

The docs.mntd.net domain and all subdomains are served by Fastly and accessible only to a whitelist of Minted Office IP addresses. If you’d like to access documentation outside of the office, you can do so through the VPN or using the docs.mntd.net Basic Auth credentials in LastPass.

Building static HTML documentation

There are many tools for generating static HTML docs: Sphinx (used for this page), Swagger UI, Aglio, to name a few. Some have deeper code or language integrations than others. Or, there are more general static site generators that can be used for documentation, such as Jekyll, Hugo, Middleman, and many others.

Whatever tool works best for your HTML workflow, the process for hosting your documentation on docs.mntd.net is the same:

  1. Build your HTML documentation (preferably as part of the CI build).
  2. Upload your files to the minted.public/docs bucket and prefix on Amazon S3 (also ideally from your CI environment). Sub-prefixes of the docs/ prefix will automatically be routed as subdomains of docs.mntd.net. So, for example minted.public/docs/waystone would be served at waystone.docs.mntd.net. It’s also possible to access sub-sub-prefixes in the bucket as deeper subdomains (eg. minted.public/docs/foo/bar is served as bar.foo.docs.mntd.net).

The AWS IAM user credentials for docs.mntd.net are stored in LastPass and you can use these credentials to upload your files to S3 as part of your build.

Modifying this page

This page is continuously deployed from the master branch of the minted/docs repo.

If you’d like to add a project or make a revision, open a PR or make a commit to the docs repo. Any changes committed to master will be built on Codeship and become visible on this page after several minutes.