hackforla / hackforla/devops

Create a pre-work onboarding issue template for general DevOps CoP members

Open
#195 0 comments 0 reactions 0 assignees View on GitHub
complexity: medium feature: templates role: DevOps Engineer size: 3pt
Dominant language
PowerShell
Stars
8
Forks
10
Avg merge
7h 30m
Merged PRs (30d)
22

Description

### Overview

We need an onboarding issue that a new DevOps CoP member can open for themselves, because right
now one does not exist. `devops` has templates only for onboarding and offboarding *leads*, and
those are performed by an existing lead rather than by the newcomer. `devops-security` has a
self-serve pre-work checklist, but it is specific to that repo and takes the member through
creating a personal AWS account and running Terraform. A person who joins the CoP and is not
going to work on devops-security therefore has no onboarding issue at all, and nothing tracks
whether they ever got set up.

### Action Items

- [ ] Confirm with the leads what a general CoP member is actually expected to do in their first
two weeks. This is the part that needs a decision, not just drafting — the answer
determines everything below.
- [ ] Write the template into `.github/ISSUE_TEMPLATE/` as a markdown template, following the
shape of devops-security's pre-work template: self-assign, pick a role label, set status,
add to the board, attend the meeting.
- [ ] Set `labels:` in the frontmatter. Note `devops` has no equivalent of devops-security's
`complexity: prework` label — decide whether to add one or use `complexity: small`.
- [ ] Keep the AWS and Terraform steps out. If a member later joins devops-security work, they
open that repo's pre-work issue then. Link to it rather than duplicating it.
- [ ] Add the template to `.github/ISSUE_TEMPLATE/config.yml` if that file gates what appears in
the picker.
- [ ] After the PR merges, go to the repo's "New issue" page and confirm the template appears and
produces a correctly labelled issue. GitHub renders the picker from the default branch
only, so this cannot be verified from your branch.

### Resources/Instructions

- Shape to follow: [pre-work-template-devops-security.md](https://github.com/hackforla/devops-security/blob/main/.github/ISSUE_TEMPLATE/pre-work-template-devops-security.md)
- What `devops` has today: `onboard-ops-cop-lead.md`, `offboard-ops-cop-lead.md`,
`recruit-new-lead.md`, `post-an-open-role.md`, plus the two blank forms — none of them is a
member self-onboarding issue
- The default branch of `devops` is `master`, not `main`
- This template is what the team-side checklist (sibling issue) will point new members at, so the
two should agree on what the member is asked to do

Contributor guide

Open the contributing guide

Research direction

Start by reviewing .github/ISSUE_TEMPLATE/pre-work-template-devops-security.md and the existing devops templates, then confirm the general member expectations with the leads. Create the self-serve markdown template in .github/ISSUE_TEMPLATE/, update config.yml if needed, and keep AWS/Terraform steps out. Done means the merged template appears in the New issue picker on master and creates a correctly labelled issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, markdown
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
57/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.