Skip to content

Welcome app inside starter templates #4201

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

Closed
kylecarbs opened this issue Sep 26, 2022 · 6 comments
Closed

Welcome app inside starter templates #4201

kylecarbs opened this issue Sep 26, 2022 · 6 comments
Labels
☂️ epic An issue of issues

Comments

@kylecarbs
Copy link
Member

kylecarbs commented Sep 26, 2022

We've received numerous issues about confusion with our getting started experience.

The primary complaint is that our Docker experience doesn't explicitly state that dialing the host is required, and our web UI doesn't indicate an error; it just says "Connecting" forever.

I've also found it confusing to have numerous Docker examples because the user is trying to optimize for "does it work," not "is it featureful?"

Step 1. Separate example templates from quickstarts

We should have a single template for each unique infrastructure type. e.g.

  • Virtual Machines on Azure
  • Virtual Machines on Google Cloud
  • Virtual Machines on Digital Ocean
  • Containers on AWS ECS
  • Containers on Docker
  • Containers on Kubernetes

Examples can be more bespoke and have additional features like dotfiles, but quickstarts should be simple and straight-forward.

Step 2. Add a getting-started HTTP server to advertise workspace applications

Instead of installing code-server in every template (which can easily get outdated or maybe just not work if the prospect is air-gapped), we should have a default application in every quickstart that displays what the user can do next. Tailscale does this nicely:

image

This would be called "Get Started" and display as a normal workspace application, but when opened a screen like this might appear:

image

This looks brutal, but you get the point.

Step 3. Add a timeout parameter to the coder_agent resource

After the specified duration of inactivity, the UI and CLI would display that something wrong happened. Templates can define a debug_url parameter in their front-matter that can direct users to a help page.

@bpmct
Copy link
Member

bpmct commented Sep 26, 2022

Huge fan of these 3 suggested improvements. Kyle and I chatted about it and decided it might be helpful for templates to link out to unique "get started" pages based on the frontmatter. Perhaps the "getting started" could also share the debug_url too

@ericpaulsen
Copy link
Member

@kylecarbs @bpmct regarding:

Step 1. Separate example templates from quickstarts

I can assist with separating out the "quickstart" start templates for each infra type from the more specific examples.

@ericpaulsen ericpaulsen self-assigned this Oct 2, 2022
@im-coder-lg
Copy link
Contributor

So, does it work now? I notice that it works better on my Raspberry Pi 4B.

@bpmct
Copy link
Member

bpmct commented Oct 3, 2022

@im-coder-lg Yeah, Coder works well on a Raspberry Pi 4B. There are sometimes (fixable) Docker issues that are present on the host and this issue suggests some improvements.

@bpmct bpmct changed the title Improve getting started experience Getting started experience Oct 25, 2022
@bpmct bpmct added the ☂️ epic An issue of issues label Oct 25, 2022
@bpmct bpmct changed the title Getting started experience Getting Started Experience Oct 25, 2022
@bpmct bpmct changed the title Getting Started Experience First Template Experience Nov 9, 2022
@bpmct bpmct changed the title First Template Experience Welcome app inside starter templates Dec 6, 2022
@BrunoQuaresma
Copy link
Collaborator

BrunoQuaresma commented Jan 10, 2023

@kylecarbs in the image that you shared, are the boxes links to the docs? Or links to the coder app?

@bpmct
Copy link
Member

bpmct commented Feb 15, 2023

Gonna close this for now. I'm not convinced we need the agent to serve an app to provide the necessary guidance for modifying apps, especially with the template builder. We did the rest of the stuff!

@bpmct bpmct closed this as not planned Won't fix, can't repro, duplicate, stale Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☂️ epic An issue of issues
Projects
None yet
Development

No branches or pull requests

5 participants