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

[FR] settings setup guide / OOBE #2284

Open
2 of 5 tasks
matmair opened this issue Nov 10, 2021 · 3 comments
Open
2 of 5 tasks

[FR] settings setup guide / OOBE #2284

matmair opened this issue Nov 10, 2021 · 3 comments
Assignees
Labels
api Relates to the API enhancement This is an suggested enhancement or new feature plugin Plugin ecosystem User Interface Related to the frontend / User Interface
Milestone

Comments

@matmair
Copy link
Member

matmair commented Nov 10, 2021

Problem
New installs can be configured a bunch - some stuff (like base url, name etc.) should really be set.

Suggested solution

  • A setup modal if it is the first run
  • Multipage wizard that guides through the experience
  • Mixin that enables plugins to show setup page
  • API endpoint to check if setups ran -> could be important for 3rd party systems
  • Maybe a role for users/admins to specify who gets shown setup screens

Describe alternatives you've considered
Make a whole setup guide in the docs - I do not think that would be as effective.

Examples of other systems
OctoPrint has a great setup workflow

Do you want to develop this?
The structure yes, I would like to discuss the details of what to show in the core contributer group

@matmair matmair added enhancement This is an suggested enhancement or new feature user interface plugin Plugin ecosystem api Relates to the API labels Nov 10, 2021
@matmair matmair added this to the 0.7.0 milestone Nov 10, 2021
@matmair matmair modified the milestones: 0.7.0, 0.8.0 Apr 30, 2022
@matmair matmair added the help wanted Assistance required label Apr 30, 2022
@matmair
Copy link
Member Author

matmair commented Apr 30, 2022

This is a vast one - deferring to later.

@SchrodingersGat @eeintech I think our Out of Box Experience (OOBE) for new settings and plugins (with settings) needs some improvement. This will take some time but should tackle it if we get more users to reduce the starting friction and support load.

@matmair matmair changed the title [FR] settings setup guide [FR] settings setup guide / OOBE Apr 30, 2022
@SchrodingersGat
Copy link
Member

Great idea @matmair - I am seeing this as a separate feature to the FTUE FR?

@matmair matmair mentioned this issue May 1, 2022
6 tasks
@matmair
Copy link
Member Author

matmair commented May 1, 2022

Great idea @matmair - I am seeing this as a separate feature to the FTUE FR?

@SchrodingersGat yes. I would see this to be much more important than #2907 and also as an architectural base to build up on for that.

@matmair matmair self-assigned this May 7, 2022
@matmair matmair removed the help wanted Assistance required label May 7, 2022
@matmair matmair modified the milestones: 0.8.0, 0.9.0 Jul 27, 2022
@matmair matmair modified the milestones: 0.9.0, 0.10.0 Oct 16, 2022
@matmair matmair modified the milestones: 0.10.0, 1.0.0 Jan 4, 2023
@matmair matmair modified the milestones: 1.0.0, horizon Jun 7, 2023
@matmair matmair added the User Interface Related to the frontend / User Interface label Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Relates to the API enhancement This is an suggested enhancement or new feature plugin Plugin ecosystem User Interface Related to the frontend / User Interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants