Kong / Kong/developer.konghq.com
Handle regions better in terraform how-tos
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 28
- Forks
- 121
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 313
Description
Our how-tos have the us region and a lot of our users use a different one, so the how-tos don't work for them.
Some were able to notice that but others didn't, and we don't mention it or link to the regions page it.
Definition of Done:
Highlight the fact that these how-tos use us region by default + link to the regions page.
Consider different options, like a prereq, a notice after the prereq, etc.
Ask Sid for design input.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Terraform how-tos that use the us region and the existing regions page. Ask Sid for design input, then choose where the notice belongs, such as a prerequisite or post-prerequisite note. Done means the how-tos clearly identify us as the default and link to the regions page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- terraform
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100