[#45647] - [Guided Tours] Add tours to empty states
- Pending
- Medium
- Build: 6.0-dev
- # 45647
- Diff
- obuisard:gt-emptystate
User tests: Successful: Unsuccessful:
Summary of Changes
Empty states often go unnoticed once a Joomla site is fully built, but when introducing new functionality, they offer a prime opportunity to guide users. Embedding a guided tour directly within these blank areas can greatly enhance user onboarding. There’s no more relevant place to learn about the functionality than in that page.
Testing Instructions
Step 1 - Check that tours are available for the News Feeds component (if it works for this component, it will work for all other empty states modified by this PR).
Make sure there are no feeds in the list of feeds and that you can see the empty state.
1 - Go to System -> Manage -> Guided Tours
2 - Disable the tour for feeds
3 - Go to Components -> Newsfeeds -> Feeds
You should NOT see a button to run the tour.
4 - Go to System -> Manage -> Guided Tours
5 - Enable the tour for feeds
6 - Set the Feeds tour Access to Super Users
7 - Create a user with Administrator access
8 - Log with that user
9 - Go to Components -> Newsfeeds -> Feeds
You should NOT see a button to run the tour.
10 - Log back in as Super User
11 - Go to System -> Manage -> Guided Tours
12 - Set the access of the tour back to Public
13 - Rename the tour identifier to 'joomla-newsfeeds-2'
14 - Go to Components -> Newsfeeds -> Feeds
You should NOT see a button to run the tour.
15 - Go to System -> Manage -> Guided Tours
16 - Set the tour identifier back to 'joomla-newsfeeds'
17 - Go to Components -> Newsfeeds -> Feeds
You should see a button to run the tour.
Step 2 - Check that the default Joomla tours are available and run from the following pages (no items must be present in the lists, you will need to trash then delete items on a test site if necessary to see the empty state):
administrator/index.php?option=com_content&view=articles
administrator/index.php?option=com_banners&view=banners
administrator/index.php?option=com_contact&view=contacts
administrator/index.php?option=com_newsfeeds&view=newsfeeds
administrator/index.php?option=com_finder&view=filters
administrator/index.php?option=com_tags&view=tags
administrator/index.php?option=com_guidedtours&view=steps&tour_id=XXX
where XXX is the id of a newly created tour.
Actual result BEFORE applying this Pull Request
Expected result AFTER applying this Pull Request
Link to documentations
Please select:
-
Documentation link for docs.joomla.org:
-
No documentation changes for docs.joomla.org needed
-
[?] Pull Request link for manual.joomla.org:
-
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_banners com_categories com_contact com_content com_finder com_newsfeeds com_tags Language & Strings Layout |
| Labels |
Added:
Language Change
PR-6.0-dev
|
||
I would have made a successful test but the tour for categories is not correct. It assumes that you are creating a tour for categories for com_content but it is displayed for all category instances. So if you have no banner categories and run through the tour you end up creating a content category and not a banner category.
Either remove the category tour from empty state (it will rarely be displayed anyway)
or
The category tour will need to be context aware to ensure that after the tour a category is created for the correct component
I would go for the first option
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45647.
Either remove the category tour from empty state (it will rarely be displayed anyway) or The category tour will need to be context aware to ensure that after the tour a category is created for the correct component
I would go for the first option
I agree, I have removed the tour link for categories.
| Category | Administration com_banners com_categories com_contact com_content com_finder com_newsfeeds com_tags Language & Strings Layout | ⇒ | Administration com_banners com_contact com_content com_finder com_newsfeeds com_tags Language & Strings Layout |
you're going to need to remove the emptystate on guided tours and steps as well
if there are no tours or steps then the tour you link to in the emptystate cant run can it ;)
you're going to need to remove the emptystate on guided tours and steps as well
if there are no tours or steps then the tour you link to in the emptystate cant run can it ;)
Hmmm... where was my brain? Yes, if there are no tours, there is no tour to run to learn about tours...
However, I need to leave the empty state changes for the 'steps' tour as an empty state is visible every time a tour is created.
There should be a check that a tour exists before the button is displayed
I have tested this item ✅ successfully on 2e593b3
Tested with JBT + patchtester 7 of the 9 given links (not com_catgeories as we have always Uncategorised and not com_guidedtours&view=tours) before the patch and after the patch. Run all seven guided tours.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45647.
Then delete the entire empty state for categories - which of course is a stupid thing to do. So why not test it for categories. Your logic fails me
Then delete the entire empty state for categories - which of course is a stupid thing to do. So why not test it for categories. Your logic fails me
@brianteeman It is not working – I would have to consider the test as failed. If I remove all categories, the 'Take a Tour' option is not offered. I assume this is related to your earlier discussion with @obuisard, which concluded with:
I have removed the tour link for categories.
@obuisard Could you please update the test instructions accordingly?
@obuisard Could you please update the test instructions accordingly?
I will try and update the PR as soon as possible with a test if the tour exists and update the test instructions.
Indeed, there are no longer tours for categories as categories are context-based and the tour available is only for com_content.
| Labels |
Added:
Feature
|
||
is this latest change correct? It seems as if it should all be in the layout instead of copy pasted across all the components
is this latest change correct? It seems as if it should all be in the layout instead of copy pasted across all the components
We need confirmation from maintainers but I believe logic should be kept out of the layout files. That is why I structured it like that.
The argument against logic not being in a layout is the same reason it shouldn't be in a template file as it is here
I have tested this item ✅ successfully on b7a2931
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45647.