search

wasmCloud / wasmCloud

wasmCloud is an open source Cloud Native Computing Foundation (CNCF) project that enables teams to build, manage, and scale polyglot apps across any cloud, K8s, or edge.
https://wasmcloud.com
Apache License 2.0
1.45k stars 140 forks source link

[FEATURE] Better documentation for providers #2957

Open peter-jerry-ye opened 3 weeks ago

peter-jerry-ye commented 3 weeks ago

Affected project(s)

Is your feature request related to a problem? Please describe.

I'm frustrated when I need to find the configuration of a specific capability provider. If I jump into the messaging-nats' page, it's actually the README of wasmcloud, rather than the README of the messaging-nats.

(By the way, I think the configuration of messaging-nats is missing a 's': 'subscriptions' instead of 'subscription')

Describe the solution you'd like

I would like to see the README of each provider displayed at the package page so that I don't need to dig in the code source's directory to find it.

Describe alternatives you've considered

No response

Additional context

No response

brooksmtownsend commented 3 weeks ago

@peter-jerry-ye this would be really nice, it's just unfortunately not possible (as far as I know) 😞 The README of a package is tied to the repository that it originates from, rather than a specified README when pushing the package.

If you know of a way to do this with GH packages, please let us know and we can get this taken care of

peter-jerry-ye commented 3 weeks ago

(I assume we are using the container registry) I think there's a 512 character description that can be added according to the document. Would it be possible if we can at least put the link to the README there?

brooksmtownsend commented 3 weeks ago

Yep we could do that, we should augment each wash push invocation in provider.yml to also include the annotation above. So for example,

wash push <rest of args> -a org.opencontainers.image.description="https://link/to/README"