Skip to content

Minor docs updates

Craig Miskell requested to merge docs-cmiskell-2022-01-06 into main

What does this MR do?

A couple of additions to the docs from my first attempt at running GET manually that may help speed the path for future newbies. In particular the previous terraform state bucket docs made me think I need to create one with the same prefix as the environment I was deploying, which is definitely wrong but you only find out when terraform bails out because the GitLab state bucket that it wants to create already exists, bu which time it's kinda fiddly to fix.

Related issues

Author's checklist

When ready for review, the Author applies the workflowready for review label and mention @gl-quality/get-maintainers:

  • Merge request:
    • Corresponding Issue raised and reviewed by the GET maintainers team.
    • Merge Request Title and Description are up to date, accurate, and descriptive
    • MR targeting the appropriate branch
    • MR has a green pipeline
  • Code:
    • Check the area changed works as expected. Consider testing it in different environment sizes (1k,3k,10k,etc.).
    • Documentation created/updated in the same MR.
    • If this MR adds an optional configuration - check that all permutations continue to work.
    • For Terraform changes: setup a previous version environment, then run a terraform plan with your new changes and ensure nothing will be destroyed. If anything will be destroyed and this can't be avoided please add a comment to the current MR.
  • Create any follow-up issue(s) to support the new feature across other supported cloud providers or advanced configurations. Create 1 issue for each provider/configuration. Contact the Quality Enablement team if unsure.

Merge request reports