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

Improve onboarding of manual imported projects #11720

Open
stsewd opened this issue Oct 29, 2024 · 2 comments
Open

Improve onboarding of manual imported projects #11720

stsewd opened this issue Oct 29, 2024 · 2 comments
Labels
Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented Oct 29, 2024

What's the problem this feature will solve?

When a project is manually imported, the user may be required to do some extra steps:

  • Set up a webhook
  • Set up an SSH key for private projects
  • Anything else?

Describe the solution you'd like

We should guide the user to complete these steps.

Alternative solutions

Do nothing, we already mention that manual steps are required when doing a manual import. Maybe link to the actual steps in the message.

Screenshot 2024-10-29 at 11-21-53 Add project - Read the Docs

Additional context

#11573 (comment)

@stsewd stsewd added the Needed: design decision A core team decision is required label Oct 29, 2024
@humitos
Copy link
Member

humitos commented Oct 30, 2024

Do nothing, we already mention that manual steps are required when doing a manual import. Maybe link to the actual steps in the message.

I think adding links in this message is a good first step. However, I don't think it's the solution, since it's pretty easy to miss those link. If the user didn't click on those links while importing it, then they will be lost.

I suppose we can detect if the project was imported manually, and in that case add a new notification explaining there are probably missing steps (the ones you mentioned in the PR description). At that point, they can decide whether to follow those steps or ignore it and close it.

@agjohnson what are your thoughts here?

@agjohnson
Copy link
Contributor

I've been looking for a notification here. I think the webhook integration page and deploy key pages could have some nicer onboarding in addition, but with the notification pointing to these pages.

The text up front is a lot to read and users will likely skip it. The notification forces interaction where any text is optional. Also, the project is not created yet, so on top of distracting users with a side quest they're also not able to change anything yet.

This was where we might have wanted to use notifications originally, and have the notification monitor these conditionals -- whether a project has a webhook or deploy key set up, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

3 participants