awsdocs / aws-doc-sdk-examples-tools

Apache License 2.0
8 stars 9 forks source link

Add console script for running doc_gen as a CLI command #40

Closed cpyle0819 closed 2 months ago

cpyle0819 commented 2 months ago

Expose a doc-gen CLI command. This command takes a root directory as input and will call DocGen.from_root. It will then serialize the DocGen instance and write that string to --write-json.

Usage: doc-gen --from-root . --write-json out.json

ford-at-aws commented 2 months ago

I am not clear on what the use case is for this. Can you describe this from a functional perspective? e.g. what does this help us do exactly.

DavidSouther commented 2 months ago

I am not clear on what the use case is for this. Can you describe this from a functional perspective? e.g. what does this help us do exactly.

We don't currently have a mechanism to serialize the captured state, you have to run it entirely each time. This lets us serialize that work, eg for later pipeline work.

Corey has a couple internal tickets this is blocking, and you'll probably find it useful for future pipeline improvements. We can talk more at standup.