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

Move AspireUpdate dashboard menu to new location OR update documentation to reflect location #210

Open
1 task done
kylek14 opened this issue Nov 26, 2024 · 10 comments
Open
1 task done
Assignees
Labels
enhancement New feature or request needs triage needs to be discussed and worked on

Comments

@kylek14
Copy link

kylek14 commented Nov 26, 2024

I have checked the following:

  • I've searched existing issues and found nothing related to my issue.

Describe the feature you want to add

The plugin menu should be located under either the settings, tools, or plugins menu. The location (Dashboard) of the config menu is not clear in the documentation and required starting up a playground instance to find the menu location.

Mockups or Images of the feature

n/a

@kylek14 kylek14 added enhancement New feature or request needs triage needs to be discussed and worked on labels Nov 26, 2024
@costdev
Copy link
Contributor

costdev commented Nov 26, 2024

@namithj I can't seem to find the discussion that led to the menu item being moved from Settings to Dashboard. Can you link to this discussion for context?

@asirota
Copy link
Member

asirota commented Nov 26, 2024

I think it was an arbitrary decision @costdev. There is no really ideal location -- probably Tools is the ideal place from my experience, followed by Settings.

@costdev
Copy link
Contributor

costdev commented Nov 26, 2024

Thanks @asirota!

Since this is configuration rather than an active tool (e.g. importer, plugin/theme file editor, Site Health), I think Settings makes more sense.

We do have the View/Clear Log functionality, which is an active tool and could be split into its own Tools > AspireUpdate Log item. However, to me that seems like a recipe for user confusion and I think the View/Clear Log functionality could continue to be bundled with the configuration.

What do others think?

@afragen
Copy link
Contributor

afragen commented Nov 26, 2024

So it usually ends up in Tools for single site and Settings on multisite.

If we plan on moving the location this is the major consideration.

@namithj
Copy link
Contributor

namithj commented Nov 27, 2024

Wouldn't it be way easier to update documentation to clarify the location of the menu.

I put it under dashboard to keep it together with updates menu and to let users see it first thing when they initially login.

@costdev
Copy link
Contributor

costdev commented Nov 27, 2024

It's useful when they first log in and makes sense in that user flow, so your reasoning there was sound.

However, I think the most common user flow will be Install -> Activate -> Navigate to the settings page. In that regard, it's more about where the user is likely to think that page lives.

  • The plugin is mostly about configuring then leaving it alone.
    • ❌ Top-level menu item isn't appropriate.
  • It's not an active tool.
    • ❌ Tools isn't appropriate.
  • Plugin options aren't usually under Dashboard.
    • ❌ Can be confusing for users, hence this issue's creation.
  • It's primarily about configuring settings.
    • ✅ Settings is appropriate.

We could update the documentation to explain the location. However, users shouldn't need documentation just to find the UI. That part should be pretty intuitive for most users.

@namithj
Copy link
Contributor

namithj commented Nov 27, 2024

I am onboard moving it to settings.

@afragen
Copy link
Contributor

afragen commented Nov 27, 2024

This change will effect more more than simply moving the menu. Saving, multisite, etc all tied in.

@afragen afragen self-assigned this Nov 27, 2024
@namithj
Copy link
Contributor

namithj commented Nov 27, 2024

Can we wait before implementing this. Right now it can be resolved just by better documentation. May be we can put it in the backlog and wait and see if it's required.

@namithj
Copy link
Contributor

namithj commented Nov 27, 2024

It's going to impact the saved settings notices and many other things, right now we have a fairly well tested plugin, we need to decide on the effort vs reward before embarking on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs triage needs to be discussed and worked on
Projects
None yet
Development

No branches or pull requests

5 participants