gruntwork-io / gruntwork-io.github.io

The gruntwork.io website
https://www.gruntwork.io
Other
41 stars 40 forks source link

Update production deployment guides #437

Open rhoboat opened 3 years ago

rhoboat commented 3 years ago

We want to revamp the walkthrough to describe the new service catalog way to deploy your infrastructure.

Resolved discussion ## Keep the old docs? [No] Is there any need to keep the old guides around for posterity? So rather than making changes here, is it better to write a whole new guide that's largely based on this? /cc @yorinasub17 @brikis98 @bwhaley @zackproser I'm leaning toward not keeping the old guides around as they are, but would like to hear alternative arguments. ## Grouping the walkthrough docs [No change] Once published/updated, I was thinking we could group all the guides together under a "Using the Service Catalog" category of tutorials, and publish announcements (blog posts) as they come out. * Deploy a production grade AWS account structure using Gruntwork AWS Landing Zone * VPC * Kubernetes Currently these are all under different headings: ![image](https://user-images.githubusercontent.com/13165182/121394060-d1fd7400-c905-11eb-8e8a-00ab3c3b3a3e.png) Is it better to group these walkthroughs differently? [No]
brikis98 commented 3 years ago

Keep the old docs?

Is there any need to keep the old guides around for posterity? So rather than making changes here, is it better to write a whole new guide that's largely based on this? /cc @yorinasub17 @brikis98 @bwhaley @zackproser I'm leaning toward not keeping the old guides around as they are, but would like to hear alternative arguments.

I think we update the existing guides, in place. No need to keep the old content around; I think that would just be confusing.

Grouping the walkthrough docs

Once published/updated, I was thinking we could group all the guides together under a "Using the Service Catalog" category of tutorials, and publish announcements (blog posts) as they come out.

  • Deploy a production grade AWS account structure using Gruntwork AWS Landing Zone
  • VPC
  • Kubernetes

Currently these are all under different headings: image

Is it better to group these walkthroughs differently?

The original thinking was that we'd have more guides, and therefore, more things to fill out each category. E.g., We'd add a VPN/SSH/Bastion guide to the networking category and a K8S service guide to the K8S category. If we group everything under "Using the Service Catalog" category, most of the guides would end up in there, which feels messy. Also, those guides aren't strictly about the Service Catalog; they are about VPCs, K8S, etc, and happen to use the Service Catalog under the hood.

rhoboat commented 3 years ago

Thanks Jim! I thought about it a bit more yesterday and felt the same way about the grouping, too.