Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 4.35 KB

GETTING_STARTED.md

File metadata and controls

68 lines (45 loc) · 4.35 KB
Raw

The Complete Getting Started Guide

Welcome to the team!

We're working on some guides to outline our team culture, and some of our development principles, but the big thing to remember is there are no stupid questions! If anything in these guides is not clear, please let us know so we can improve them for future team members.

Set up your mac for development work

  1. Install applications
  2. Set up your git config
  3. Set up your GPG keys
  4. Set up your AWS account access
  5. Install the dp-cli tool
  6. Run dp remote allow sandbox to prove all your previous setup is correct. The output should include [dp] allowing access to sandbox. Ask for help if you encounter errors or warnings.
  7. Add environment keys to keychain. First, you'll need to ask one of the senior developers for the sandbox passphrase or ask your Tech Lead for the prod passphrase.

Note: If you cannot access this link, something has gone wrong in the previous step.

Install, configure and run services

  1. Install the prerequisites
  2. Clone the repositories
  3. Setup base content
  4. Setup base environment configuration
  5. Run the apps
  6. Update configuration for your credentials

We've made a few attempts at simplifying these steps, but haven't converged on one way of doing things yet. The alternatives are detailed in our developer setup guide.

Usage guides

  1. (Optional) Enable feedback form
  2. Publishing system guide
  3. CMD import guide

Set up for infrastructure & CI work

⚠️ All steps in this section link to private repositories. If the links don't work for you, revisit the steps in setting up your mac to ensure you're a member of our Github organization.

For all work in this area you will first need to:

  1. Install ansible
  2. Configure access to servers

Infrastructure

All infrastructure configuration is managed in dp-setup and includes the following pieces of set up:

  1. Install the prerequisites for terraform
  2. Install any additional dependencies for ansible

Continuous Integration (CI)

All CI configuration is managed in dp-ci and includes the following pieces of set up:

  1. Install any additional dependencies for ansible
  2. Install the fly command by going to the Concourse UI and selecting the Apple from the CLI list in the bottom right of the screen.

CMD import steps

  1. Import recipes using the import-recipes script
    • If you're running a local graph database like Neo4j you'll also need to import code lists for the recipes you'll be using and may need to import hierarchies.
    • In most cases this is not currently needed, as we use a shared instance of Neptune running in the Development AWS account.
  2. Create datasets
  3. Import a file
  4. Publish a collection