Need a Readme for your repo? Unsure what to put in it? This template is here to help <3
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

Title

Brief text description of the main purpose of the repo / application in the context of our platform.

Contents [if README is very large]

  1. Getting Started
  2. Making Changes
  3. Architecture
  4. General Operation
  5. Deployments
  6. Monitoring
  7. Troubleshooting
  8. To Do

Getting Started

Step by step guide for getting the application/project/tool set up for local development, including:

  • Installation dependencies
  • Any scripts or commands to run for local set up of the app
  • make (or similar) command for running tests

Making Changes (if applicable, i.e. if not fully obvious)

If noteworthy, please detail the general flow of making changes (a nice example is this workflow for making changes to a Chef Repo).

Architecture

  • Include your awesome diagrams here
  • Consider including relevant context of the app/tool/project

General Operation

  • Operating considerations pertaining to how the app/project/tool runs in production
  • Related applications / dependencies

One example is the General Operation section on the Solr indexers.

Deployments

  • Where is it deployed?
    • Load balancer (internal or external)
    • Cloud services
  • How is it deployed?
    • CI pipeline
    • Specific deployment requirements

NB: If the repo isn't itself a deployable app (libaries, deploy tools like Edamame etc.), please still point out the CI pipeline used to run automated tests for the project.

Monitoring

  • Dashboards
    • Datadog
    • SumoLogic
    • Grafana
  • Pingdom

Troubleshooting

To Do

  • WIP/info in case of newer repos or ongoing projects (i.e. cloud migrations)