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.

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

Show supported cloud targets in winglib READMEs #7028

Open
Chriscbr opened this issue Aug 20, 2024 · 1 comment
Open

Show supported cloud targets in winglib READMEs #7028

Chriscbr opened this issue Aug 20, 2024 · 1 comment
Assignees
Labels
📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request 👠 platforms Issues relating to Wing Platform Providers

Comments

@Chriscbr
Copy link
Contributor

Use Case

It's not always clear when downloading a winglib what targets it supports. Sometimes you might start building an app with the simulator and stumble onto compatibility issues later once you need to deploy to another target.

Proposed Solution

The README of each published winglib should prominently show what targets it supports. See for example https://www.npmjs.com/package/@winglibs/dynamodb

Implementation Notes

We store some metadata about the supported targets inside package.json here:

https://github.com/winglang/winglibs/blob/3bab75b50c70af0fc23fa7b5a9d32bc5c0e1de97/dynamodb/package.json#L19-L22

Component

Documentation, Libraries

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out on the #dev channel in the Wing Discord.
@Chriscbr Chriscbr added 📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request 👠 platforms Issues relating to Wing Platform Providers labels Aug 20, 2024
@boyney123
Copy link
Contributor

Makes sense!

@boyney123 boyney123 self-assigned this Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request 👠 platforms Issues relating to Wing Platform Providers
Projects
Status: Backlog
Development

No branches or pull requests

2 participants