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

Do not auto create dummy content item when AdminDashboard feature is enabled #13485

Closed
MikeAlhayek opened this issue Mar 29, 2023 · 17 comments · Fixed by #13486
Closed

Do not auto create dummy content item when AdminDashboard feature is enabled #13485

MikeAlhayek opened this issue Mar 29, 2023 · 17 comments · Fixed by #13486

Comments

@MikeAlhayek
Copy link
Member

Is your feature request related to a problem? Please describe.

When AdminDahsboard feature is enabled for the first time, for some reason we create a dummy dashboard item. There is no way to avoid this for new tenants currently.

Describe the solution you'd like

I don't think adding a content item by default is a good idea because the admin will almost always have to remove it. Remove the Orchard Core admin widget from the recipe.

@hishamco
Copy link
Member

You read my mind, I just notice that last week :) probably we might need to polish the UI or to add the default widgets

@hishamco
Copy link
Member

hishamco commented Mar 29, 2023

I think @agriffard created that module, I'm sure there's a reason for showing some default HTML widgets

@ns8482e
Copy link
Contributor

ns8482e commented Mar 30, 2023

IMHO we should keep the default dashboard item As it gives new user a ready to use HTML dashboard experience with Orchard Core branding links.

@MikeAlhayek
Copy link
Member Author

@ns8482e a good place for an ready state is a startup recipe not a sub-recipe that is called from a migration. I want to create a recipe that provides my own dashboard widgets by default. I can't do exactly that because I'll always will have to remove the default widget manually. If we feel we need to have a placeholder, then we may want to add it to an existing startup recipe or add a new startup recipe with a Dashboard default.

@ns8482e
Copy link
Contributor

ns8482e commented Mar 31, 2023

IMHO dashboard feature is Orchard Core's Admin Feature(not for front end or startup recipes) Enabling this feature adds HTML dashboard with content specific to orchard core Cms. So default content item should not be removed. If customization is needed you can always customize using editor or using custom recipe.

@MikeAlhayek
Copy link
Member Author

A recipe is something you use to create a full site (i.e., Front end, admin, features, default content,settings....).

When you providing a SaaS product, you want to deliver a complete product "as much as possible" out of the box. So if my recipe create the site with multiple admin dashboards, why should I have to also show the default/placeholder widget? I think default contents should be part of optional recipe. Either a startup recipe or a partial recipe that gets called as needed but not forced upon you. If we at least hardcode the content item id, we can probably delete the content by its hard codes id from a recipe. Either way, I strongly believe this should be removed

@hishamco
Copy link
Member

I think it was a sample use case for how the dashboard widgets should look, maybe it needs a better design.

If we at least hardcode the content item id, we can probably delete the content by its hard codes id from a recipe. Either way, I strongly believe this should be removed

While the feature management doesn't have sort of checklist for some default settings, the solution either leave it as its or remove it

@ns8482e
Copy link
Contributor

ns8482e commented Mar 31, 2023

You are correct in your point of view, where you would like to make enhancements on top of what orchard core cms.

At the other end, orchard core cms is not just saas framework rather complete ready to use cms application. The OOTB dashboard content html item is ready to use dashboard is for non technical cms users.

When the ask here is to remove OOTB dashboard item feature, means to remove a dashboard feature for non techie cms users.

@MikeAlhayek
Copy link
Member Author

I still believe that the default content should be part of a recipe like the blog recipe where the user gets a starting point. But we should have a way to opt out default content.

@ns8482e
Copy link
Contributor

ns8482e commented Mar 31, 2023

Correct - request is genuine, removing feature for non tech users from module is not good idea. As after this change, enabling the feature does nothing and will show blank dashboard page that is confusing to CMS non-developer end users

@MikeAlhayek
Copy link
Member Author

What do you suggest we do then?

@myetginbal
Copy link

I kinda agree with @MikeAlhayek, the default content may be a part of a pre-defined recipe but not a blank one. Afaik, the dashboard item is still being automatically generated even after you import a custom recipe that does not contain it. I believe, at least it should not show up after a custom recipe is imported.

@ns8482e
Copy link
Contributor

ns8482e commented Apr 1, 2023

One idea that I think of is to repurpose current Admin Dashboard to provide tools to manage
Dashboard and create another module like orchard core cms dashboard - that will create dashboard content items specific to OOTB orchard core cms - with dependency on current admin dashboard - and enabled by default by OOTB setup recipes.

In future we can also use orchard core cms dashboard module with [RequiresFeature] to add dashboard items specific to other modules/themes to add OOTB dashboard items

As SaaS provider you can exclude orchard core cms dashboard from your custom saas recipe.

@MikeAlhayek
Copy link
Member Author

@sebastienros can you please shed some light on this issue?

@hishamco
Copy link
Member

@MikeAlhayek we could do this on the next triage meeting

@sebastienros
Copy link
Member

During the meeting we suggested to create a sample recipe with the current content. This can then be called independently of the enable action.

@MikeAlhayek
Copy link
Member Author

@sebastienros a recipe was added. I also update the 1.7 release notes with the changes in the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants