Optum / Optum/runiac

document learned lessons from steps

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
24
Forks
19
Avg merge
11m
Merged PRs (30d)
2

Description

- terraform runner: prefer a single step where possible
    - reasons to expand: 
        - When it becomes burdensome for a single state file to handle the amount of resources
        - When it is easier to have explicit separation (e.g. configuring pagerduty or another third party service)
        - When a specific part of the step becomes a high churn area, it could be valuable to move it to own's step where that be developed on individually.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named. Start by locating the repository documentation for the Terraform runner and compare it with the lessons in this issue. Done means the guidance on using one step, splitting state, separating third-party services, and isolating high-churn areas is documented clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
terraform
Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.