hackforla / hackforla/devops

Identify and Create Issues for future DevOps Guides

Open
#132 5 comments 0 reactions 0 assignees View on GitHub
complexity: small feature: guide creation ready for CoP Lead role: CoP lead size: 0.5pt
Dominant language
PowerShell
Stars
8
Forks
10
Avg merge
7h 30m
Merged PRs (30d)
22

Description

### Overview
We need to identify guides to make and create issues for them, so that they can get worked on, and we can refer to finished guides in issues (where the guidance is needed) and our wikis.

### Action Items
- identify guides that need to be created (making sure they don't already exist)
- [ ] confirm they don't already exist by looking at the project boards where guides across multiple CoPs reside (resource 1.01)
- [ ] if they don't exist, add them to the List of Guides to make below
- create issues
- [ ] Go to resource 1.04
- [ ] Choose the appropriate template:
- [ ] Create a New Guide - With Examples from Multiple Teams
- [ ] Create a New Guide - With Prescriptive Instructions
- [ ] Add the label: `CoP: Ops`
- link the guides so that they are easy to find
- [ ] Link the guide issue back to this issue
- [ ] Add the guide issue to the following project boards (resources 1.01 and 1.02)
- [ ] Make sure that the guide issue is showing up on resource 1.03

### Resources/Instructions
- 1.01 [P: Guides: Knowledgebase Content Tracker](https://github.com/orgs/hackforla/projects/40)
- 1.02 [CoP: DevOps: Project Board](https://github.com/orgs/hackforla/projects/73)
- 1.03 [Templates and Guides, DevOps tab](https://github.com/orgs/hackforla/projects/40/views/11) - this is linked from our wiki
- 1.04 [knowlegebase-content repo, new issue tab](https://github.com/hackforla/knowledgebase-content/issues/new/choose)

#### List of guides to make - With Examples from Multiple Teams
- Create a Guide/Template: Setup Docker

#### List of guides to make - With Prescriptive Instructions
- https://github.com/hackforla/knowledgebase-content/issues/70 - Adding a project to incubator
- Create a Guide/Template: How to access logs to debug with your project team
- see https://github.com/hackforla/ops/issues/92 for logs available
- Create a Guide/Template: What to store in 1password (Secrets, ports tokens)
- Create a Guide/Template: When to graduate your project from incubator
- Create a Guide/Template: Using Terraform

#### List of guides to make - Unsure
- Setting up Dev & Production Environments
- Create a Guide/Template: Setting up Dev & Production Environment - AWS
- Create a Guide/Template: Setting up Dev & Production Environment - Azure
- Create a Guide/Template: Setting up Dev & Production Environment - gh-pages

Contributor guide

Open the contributing guide

Research direction

Start by checking the Knowledgebase Content Tracker and DevOps project board to verify which listed guides already exist. Review the new-issue templates in the knowledgebase-content repository, then create and label missing guide issues, link them back here, and confirm they appear on the required boards and DevOps view.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, azure, docker, github, terraform
Domain
cloud, devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.