Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Update docs to clarify PDK vs Projen #678

Closed
agdimech opened this issue Jan 14, 2024 · 1 comment · Fixed by #753
Closed

[DOCS] Update docs to clarify PDK vs Projen #678

agdimech opened this issue Jan 14, 2024 · 1 comment · Fixed by #753
Labels
backlog documentation Improvements or additions to documentation needs-triage

Comments

@agdimech
Copy link
Contributor

Describe the issue

Some customers have mentioned that it is not clear what the difference between Projen vs PDK is. Update all docs to mention that PDK is an extension of Projen.

Something to the effect of:

The AWS PDK is an open-source extension of Projen, that provides opinionated implementations to common patterns for quickly defining solutions on AWS.

Links

https://cdk-dev.slack.com/archives/C01BP9PQHPC/p1705033815386249
@agdimech agdimech added documentation Improvements or additions to documentation needs-triage labels Jan 14, 2024
@github-actions GitHub Actions
Copy link

This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@github-actions github-actions bot added the stale label Mar 18, 2024
@github-actions github-actions bot removed the stale label Mar 25, 2024
cogwirrel added a commit that referenced this issue Apr 8, 2024
@cogwirrel
docs: use npx projen commands in examples and clarify pdk vs projen
80b2d80 
To help clarify PDK vs Projen, use projen commands in examples instead of PDK cli, and reword parts
of the documentation. Also remove the migration banner from the README.

Fixes #678
@cogwirrel cogwirrel mentioned this issue Apr 8, 2024
Merged
cogwirrel added a commit that referenced this issue Apr 8, 2024
@cogwirrel
docs: use npx projen commands in examples and clarify pdk vs projen (#…
3beec6f 
…753)

To help clarify PDK vs Projen, use projen commands in examples instead of PDK cli, and reword parts
of the documentation. Also remove the migration banner from the README.

Fixes #678
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog documentation Improvements or additions to documentation needs-triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: use npx projen commands in examples and clarify pdk vs projen aws/aws-pdk
2 participants
@cogwirrel @agdimech