Clean Up Existing Documentation

[robinglov]

Overview

We need to be able to easily distinguish between legacy Terragrunt documentation and new Terraform documentation in /incubator/documentation and eliminate confusing redundancies between /documentation and the Incubator Wiki.

Action Items

• [x] Determine which .md files are outdated and add them to resource 1.02. These will have references to Terragrunt
• [ ] Compare files in Wiki and /documentation. Screenshot and note found redundancies in resource 1.03.
• [ ] Determine what changes should be made. Possible options below
  • [ ] Tag any suspected legacy code as LEGACY with (### legacy)
  • [ ] remove from documentation
  • [ ] ??

Resources/Instructions

• 1.01 Repo Incubator documentation: Documentation link
• 1.02 Spreadsheet Terragrunt references in repo
• 1.03 DevOps: Incubator documentation redundancy details
• 1.04 Terragrunt Code Search Result in Incubator Repo
• 1.05 Terragrunt Code Search Result in Ops Repo

[jennyc910]

Action Items

• [x] Determine which .md files are outdated. These will have references to Terragrunt.
  • Deploying-With-Terragrunt.md
  • Installation-Instructions.md
  • Setting-Up-Incubator-Environment.md
• [ ] Tag any suspected legacy code as LEGACY with (### legacy)
• [x] Compare files in Wiki and /documentation. Screenshot and note found redundancies in this Google Doc.

[jennyc910]

Notes from 2024-03-05 Meeting

• We created a spreadsheet for auditing files that reference Terragrunt, which would inform the next steps we need to take.

Action Items

• [ ] Complete the Terragrunt references in repo spreadsheet

[ExperimentsInHonesty]

@jennyc910 Please provide update

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."

• remember to add links to the top of the issue if they are going to be needed again.

[ExperimentsInHonesty]

We need to go over this with the CoP lead and figure out what the next steps are. Marking as legacy didn't really clarify anything. And a bunch of work has been done on this issue already, lets move it forward though discussion and revision

[ExperimentsInHonesty]

I will break this down by file type.

Make an epic to look at each HCL file, and determine if it needs to be deleted or replaced with a terraform script. Then make issues for each service that will need to be written in terraform.
The issues will live in the icebox or prioritized backlog (to be discussed) once the issues are made.