search

cdklabs / cdk-nag

Check CDK applications for best practices using a combination of available rule packs
Apache License 2.0
764 stars 56 forks source link

Documentation Improvements. #1079

Open mrpackethead opened 1 year ago

mrpackethead commented 1 year ago

Description

There are some areas of cdk-nag which cold benefit for some more documentation / tutorials.

(1) Lack of Python examples: Python is probalby the second most used Cdk Language. Mirror the how to use documents in Python.

Use Case

Becuase i use CDK in Python as well as Ts

Proposed Solution

Write examples for Python / Mirror the typescript documents.

Other information

I will write this and submit a PR

Acknowledge

dontirun commented 1 year ago

I'm worried about the README becoming too long and hard to read (if the examples were to be mirrored there). Some thoughts related to this.

  1. The ConstructHub page for cdk-nag does a best effort translation of the README examples to Python (and I believe that those translations work). Instead of mirroring examples in the README, perhaps we make it a point to point users to there
  2. Perhaps a dedicated examples folder or cdk-nag specific examples in the cdk-examples repo, and we point users to there