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

Add info box before creating codespace: Enter details! #4

Open
agardnerIT opened this issue Nov 27, 2024 · 0 comments
Open

Add info box before creating codespace: Enter details! #4

agardnerIT opened this issue Nov 27, 2024 · 0 comments

Comments

@agardnerIT
Copy link
Collaborator

We've had user feedback in other demos that (because GitHub cannot yet make secrets mandatory) it is easy to quickly scan the "form page" and for users just to click submit. Thus the scenarios spin up with missing critical info.

I've requested an enhancement with GitHub, but until then we need to protect against this.

  • Step 1 will be to add a clear admonition / info box to the docs just before the "create a new codespace" instructions (a sample is given below)
  • Step 2 perhaps will be to include a screenshot, making this even harder to miss
  • Step 3 will be to add code-level checks into the spin-up code to "fail fast"
!!! info"Enter Required Information"
    During the next step you will be prompted for these details.

    Enter the relevant details in the GitHub form!
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