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

Enrich the Hub API #1069

Open
itowlson opened this issue Dec 4, 2023 · 3 comments
Open

Enrich the Hub API #1069

itowlson opened this issue Dec 4, 2023 · 3 comments

Comments

@itowlson
Copy link
Contributor

itowlson commented Dec 4, 2023

I am exploring the idea of Hub integrations, e.g. via a plugin. This issue is to track things that would be useful to have in the Hub API, and will be a journey, so we can figure things out and do them when we have a fuller picture.

@itowlson
Copy link
Contributor Author

itowlson commented Dec 4, 2023

Templates

There should be a way to get the repo containing the template (so it can be installed), and the ID of the template (so it can be run). Cf. itowlson/spin-hub-cli#1

Possible: Dependencies - Hub references (e.g. js2wasm), or text/URLs pointing the user to external dependencies (e.g. Zola). This might be better off in the core template system though.

@itowlson
Copy link
Contributor Author

itowlson commented Dec 14, 2023

Plugins

Not sure how valuable this is, but if we think it's worth it, then it would need the install location: depending on the plugin, this would be a name in the plugins registry, or a URL to a manifest.

The API should also surface the name of the plugin (not just a description). So I could go spin hub install-plugin trigger-sqs and it could resolve that exactly without needing a search. This would also enable a more focused spin hub install-trigger sqs command where the user only needs to know the trigger type not the naming convention (or other representation).

@itowlson
Copy link
Contributor Author

itowlson commented Dec 14, 2023

Samples

Distinguish between blog posts and runnable samples (e.g. GH repos).

For runnable samples, I think we'd want the git URL, and the path to spin.toml if not at the root. Still noodling on this though.

Prerequisites info e.g. any plugin that needs downloading, commands like npm install or pipenv update that need to run first.

Usage info. E.g. for the QR code sample, it's not clear which route to click; and when you guess right, it asks for credentials and it's non-obvious where to find them (especially if you do deploy rather than up, so you don't even have the visible logs to clue you in). So some way to show a guidance message or link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant