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

• Determine which .md files are outdated. These will have references to Terragrunt.
• Tag any suspected legacy code as LEGACY with (### legacy)
• Compare files in Wiki and /documentation. Screenshot and note found redundancies in this Google Doc.

Resources/Instructions

Documentation link
Terragrunt references in repo
Terragrunt Code Search Result in Incubator Repo
Terragrunt Code Search Result in Ops Repo

[jennyc910]

Action Items

• 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)
• 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.