aws-cli icon indicating copy to clipboard operation
aws-cli copied to clipboard
verified publisher icon aws

docs: Add VPC Lattice concepts and troubleshooting guide (#9351)

Open deepatidarr opened this issue 10 months ago • 3 comments

*Issue #9351 *

Description of changes: This PR adds comprehensive documentation for Amazon VPC Lattice in the AWS CLI examples.

The documentation includes:

  • Core concepts and components of VPC Lattice
  • End-to-end setup example with AWS CLI commands
  • Best practices for security, monitoring, and scalability
  • Detailed troubleshooting guide with common issues and solutions
  • Diagnostic commands for common operations

Fixes #9351

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

deepatidarr avatar Mar 09 '25 23:03 deepatidarr

How did you test or intend to consume this @deepatidarr ?

We have one existing _concepts.rst file for S3, which are hand-written commands unlike VPC Lattice. https://github.com/aws/aws-cli/blob/558d3d4134882003550035724a4c8549771fd79c/awscli/customizations/s3/s3.py#L52

I don't believe we'll pick up this file for the HTML API reference. Was that your intention?

ashovlin avatar Mar 12 '25 18:03 ashovlin

Hey, first of all thanks for reviewing my contribution. My intention was to provide comprehensive documentation for VPC Lattice in a similar manner to the existing S3 _concepts.rst file. I just wanted to enhance the understanding of VPC Lattice concepts and provide practical examples and troubleshooting tips for users.

Also, yes that was my intention, if there are specific steps or modifications needed to ensure it is picked up for the HTML API reference or any other documentation process, I would appreciate your advice.

Again, thank you for your time.

deepatidarr avatar Mar 12 '25 19:03 deepatidarr

At this time we don't have plans to support plumbing new _concepts.rst files into the HTML reference like we have for the hand-written s3 commands.

If you are still interested in improving VPC Lattice documentation, we'd consider new or improved operation-specific examples, which already flow into the HTML docs. Here are the contributing guide pages that cover the examples:

  • https://aws.github.io/aws-cli/docs_quicksteps.html
  • https://aws.github.io/aws-cli/docs_styleguide.html

ashovlin avatar Mar 31 '25 17:03 ashovlin