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

Enable 1-click remote dev environments for all tutorials with Gitpod or Codespaces #937

Open
chuck-confluent opened this issue Sep 9, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@chuck-confluent
Copy link

chuck-confluent commented Sep 9, 2021

The current kafka tutorials user experience is sub optimal:

  • User must install Docker, ccloud CLI, and sometimes other tools
  • User must download several GB of docker images
  • User must do things like exec into containers in order to use tools installed within

Ideally the user experience would be:

  • Click a link to open a remote dev environment with all prerequisites baked in.
  • Focus entirely on the learning objective

This more ideal user experience is possible with gitpod workspaces or GitHub Codespaces. In fact, I've already "gitpodified" a kafka tutorial here!

Enabling gitpod would require configuring a .gitpod.yml file in the repo root. Gitpod doesn't yet support multiple .gitpod.yml files, but as a workaround, we could use environment variables via URL (docs and example) to automatically change into the proper code directory on launch. This would mean we'd need one workspace to be able to run any tutorial which should be fine since everything is on docker. If something's not on docker, we could just install it to the workspace, or alias it with docker underneath (e.g. how the az CLI is aliased in the kafka docker playground project here)

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

No branches or pull requests

1 participant