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

Issue walkthrough #1

Open
12 of 17 tasks
phorcys420 opened this issue Feb 6, 2023 · 8 comments
Open
12 of 17 tasks

Issue walkthrough #1

phorcys420 opened this issue Feb 6, 2023 · 8 comments

Comments

@phorcys420
Copy link
Member

phorcys420 commented Feb 6, 2023

I was thinking it would be interesting to take users through a little series of questions when they create a new thread in #help

Flow

  1. Choose issue category : Help needed, Bug report, Feature request
    if feature request or bug report then probably redirect them to GH issues and lock thread.
  2. What product is this issue related to ? Coder v1, Coder v2, code-server
  3. What platform are you running the product on ? Linux, Windows, macOS
  4. What runtime are you using to run the product ? Docker, SystemD (depending on platform)
  5. Have you posted logs ? if no, please do
  6. Tell users to mention anything else that could matter (product version, etc)
  7. The bot posts a summary of the issue and pins it

For each category, a tag should be added to the issue.


I think the message should delete itself after 5 minutes of inactivity.

Implementation 1 (discarded)

Have the user run a command that shows a modal to them.
This is nice but it requires running a command, which makes the UX poorer.

Implementation 2 (choosen)

Sending a self-editing message on every thread creation that contains action rows

I think this gives better UX but we might get the bot rate-limited if too much threads are created at once.


Roadmap

  • Action row components
    • Base components and questions
    • "Other" entries for every question
    • Styled components (emojis in action rows)
  • Action row events
    • Item selection is handled properly and state-agnostic
    • Only the owner of the post and admins can use the walkthrough
  • Walkthrough is sent on post creation
  • Back button under action rows so you can correct input mistakes
  • Summary message
    • The thread name is displayed
    • Infos from the questions are displayed
    • The summary is pinned automatically
    • Summary is good-looking (maybe use embeds?)
    • Log locations are indicated to the user
    • The pin alert message is automatically deleted
@matifali
Copy link
Member

matifali commented Feb 6, 2023

also, add instructions on how to get logs. like showing them commands and asking users to paste the output they get from running each command.

@phorcys420
Copy link
Member Author

add instructions on how to get logs. like showing them commands and asking users to paste the output they get from running each command.

yes that's a good idea, i will also add a "platform" dropdown so that it gives the appropriate log locations.

@phorcys420
Copy link
Member Author

Here is a quick prototype i sat up.

Discord_2GnP8VvJrp

It currently posts twice because I am unable to distinguish between thread creation and thread join due to an issue in the library's repo (nyxx-discord/nyxx#440)

@phorcys420
Copy link
Member Author

Here is an updated version of the flow.
I will also add icons for other dropdowns, I was just lazy.

Discord_TEVmBvKZAI

@phorcys420
Copy link
Member Author

phorcys420 commented Feb 25, 2023

here's how it looks now, it will also be the first rollout I think

Discord_ujZlx8NtGR

@matifali
Copy link
Member

Many people who discover coder from GitHub do not know abut v1 and v2. They only know coder.

@phorcys420
Copy link
Member Author

👍
I could also add the repo name ?
I think it's sensible to keep the v1 entry until the sunset is complete though
Discord_UNlEhqAvk8

This is kind of too much though, maybe I should just get rid of v1 altogether ?

@matifali
Copy link
Member

yeah I suggest removing v1 as that is supported on slack.

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

2 participants