Skip to content

Issue walkthrough #1

@phorcys420

Description

@phorcys420

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions