Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up Existing Documentation #60

Open
1 of 6 tasks
robinglov opened this issue Mar 4, 2024 · 5 comments
Open
1 of 6 tasks

Clean Up Existing Documentation #60

robinglov opened this issue Mar 4, 2024 · 5 comments
Labels
complexity: medium feature: documentation Project documentation additions or updates ready for product role: product size: 1pt Can be done in 4-6 hours

Comments

@robinglov
Copy link
Member

robinglov commented Mar 4, 2024

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 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

@robinglov robinglov added role: product size: 1pt Can be done in 4-6 hours complexity: medium feature: documentation Project documentation additions or updates labels Mar 4, 2024
@robinglov robinglov added this to the 06 - Documentation/Templates milestone Mar 4, 2024
@robinglov robinglov changed the title Remove legacy Terragrunt documentation Clean Up Existing Documentation Mar 4, 2024
@robinglov robinglov mentioned this issue Mar 4, 2024
@jennyc910
Copy link
Member

jennyc910 commented Mar 5, 2024

Action Items

@jennyc910

This comment was marked as outdated.

@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty
Copy link
Member

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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: medium feature: documentation Project documentation additions or updates ready for product role: product size: 1pt Can be done in 4-6 hours
Projects
Status: Questions/Review
Development

No branches or pull requests

4 participants