powertools-lambda-typescript icon indicating copy to clipboard operation
powertools-lambda-typescript copied to clipboard

Docs: add development and bundling setup info

Open dreamorosi opened this issue 1 year ago • 1 comments

What were you searching in the docs?

Customers using Powertools require a varying number of configs & tooling in their project depending on their setup. For example: Node.js version, TypeScript version and tsconfig.json, ESM vs CJS, bundling for production, etc.

This can be confusing, especially because some of the combinations have gotchas, and it's usually one of the first things we ask when troubleshooting customer issues (example).

Is this related to an existing documentation section?

No response

How can we improve?

We should consider adding a section or page dedicated to elaborating on the required config both for development and bundling so that customers can refer to it.

Got a suggestion in mind?

No response

Acknowledgment

  • [X] I understand the final update might be different from my proposed suggestion, or refused.

dreamorosi avatar Apr 18 '24 10:04 dreamorosi

I am not sure yet whether this should be a section in an existing page or a standalone page.

My main doubt at this stage stems from the fact that - at least in my opinion - none of the pages we have fit this topic. This is because all pages except the home are dedicated to a specific feature while this is a cross cutting topic.

Additionally, I am unsure whether we should discuss both suggested development environment to use Powertools and bundling for production, or both. At the moment we give some guidance in the contributing section, but this is targeted primarily at the dev setup to contribute to the project.

I think overall this is an important section to be added, however I'm concerned about scope creep.

dreamorosi avatar Apr 18 '24 10:04 dreamorosi

Closing this in favor of #2948

dreamorosi avatar Feb 07 '25 18:02 dreamorosi

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

github-actions[bot] avatar Feb 07 '25 18:02 github-actions[bot]