Part of #1921152: META: Start providing tour tips for other core modules.

Problem/Motivation

Write tour integration for User edit page

Proposed resolution

Create tour yml files for the user edit screen in 'user/*/edit'.

Remaining tasks

Provide patch of tour integration for the user edit page.

User interface changes

New tours

API changes

None

Technical pointers when creating tour tips

See: https://drupal.org/node/1921152#tour-tips-tech-note for tech notes on making tour tips.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

lea.refice’s picture

I plan to continue working on this issue.

nick_schuch’s picture

Issue tags: +Needs tests

Tour needs tests since we now have #2028535

nick_schuch’s picture

Hi lea.refice,

How are your travelling with this issue? Is there anything I can help with?

Nick

nick_schuch’s picture

Issue tags: +Tour

Tagging for tour issue tracking.

Boaah’s picture

Assigned: lea.refice » Unassigned
Status: Active » Needs review
FileSize
1.47 KB

Since lea.reflce has not done anything yet I have allowed myself to create my first drupal core patch which prepares the tour file for further development.

The patch creates the tour.tour.user-edit file for the user core module in the config folder. It also contains some simple tour tips.

larowlan’s picture

  1. +++ core/modules/user/config/tour.tour.user-edit.yml
    @@ -0,0 +1,40 @@
    +id: user
    ...
    +label: User
    

    Lets make this something more specific - eg 'User edit'. Same for the label.

  2. +++ core/modules/user/config/tour.tour.user-edit.yml
    @@ -0,0 +1,40 @@
    +    body: 'The <em>username</em>, <em>password</em> and <em>E-Mail address</em> are needed for the user to login.'
    

    Email isn't needed for login. But it is required to be unique. Lets say that.

  3. +++ core/modules/user/config/tour.tour.user-edit.yml
    @@ -0,0 +1,40 @@
    +    body: 'The status determinates if the user is able to login or not.'
    

    Lets expand on this. To explain why a blocked account is useful. Also can we link to the settings page where they can set the default value for new users.

  4. +++ core/modules/user/config/tour.tour.user-edit.yml
    @@ -0,0 +1,40 @@
    +    body: '<a href="/admin/people/roles">Roles</a> are needed to grant and revoke access for the user to different parts of the system.'
    

    You need to use a token here, sites installed in /drupal won't link with /admin/people/roles. You can use [site:url] then append the path. Grant and revoke 'permissions' instead of access perhaps?

  5. +++ core/modules/user/config/tour.tour.user-edit.yml
    @@ -0,0 +1,40 @@
    \ No newline at end of file
    

    Needs newline at end of file

Screenshot 2013-10-03 08.22.26.png

+++ core/modules/user/config/tour.tour.user-edit.yml
@@ -0,0 +1,40 @@
+id: user

This should match the id in the filename (user-edit). I think thats why it doesn't show up when I visit user/*/edit.

Boaah’s picture

Thank you for your feedback! I tried to improve the tour with the help of your suggestions.

Status: Needs review » Needs work

The last submitted patch, improves_user_edit_tour-2044399-7.patch.patch, failed testing.

Boaah’s picture

Fix for the last broken patch.

floydm’s picture

Status: Needs work » Needs review
FileSize
3.45 KB

The attached patch adds a test for the user/*/edit tour to the patch in #9.

nielsonm’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
Issue tags: -Needs tests

Works for me.

batigolix’s picture

Status: Reviewed & tested by the community » Needs review

The code may work but the content & wording needs a proper review first

nick_schuch’s picture

I will have a chat with @pameeela about reviewing the wording on this one. She has become the moderator for the tour content.

Anonymous’s picture

For me it makes sense to use the same tour for adding users.

larowlan’s picture

nick_schuch’s picture

Assigned: Unassigned » nick_schuch
nick_schuch’s picture

Here is the latest patch with includes:
- Update of paths to routes.
- Removal of overlay tips and references in test coverage.

Ready for content review.

Status: Needs review » Needs work

The last submitted patch, 17: tour-user-edit-page-2044399-17.patch, failed testing.

nick_schuch’s picture

Status: Needs review » Needs work

The last submitted patch, 19: tour-user-edit-page-2044399-19.patch, failed testing.

nick_schuch’s picture

Status: Needs work » Needs review
FileSize
3.4 KB
2.66 KB

I have updated the schema as per previous fail. Also included a fresh interdiff form before the fail.

webchick’s picture

Status: Needs review » Postponed

This one seems like a good thing to do, but postponed on #1921152-109: META: Start providing tour tips for other core modules. for now.

mgifford’s picture

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Farnoosh’s picture

Assigned: nick_schuch » Farnoosh

I am working on this issue in Drupalcon Nashville

Farnoosh’s picture

Status: Postponed » Active
Issue tags: +Nashville2018
Farnoosh’s picture

Farnoosh’s picture

Status: Active » Needs review
DrupalMattS’s picture

Status: Needs review » Needs work

The file should be added to the config/install folder. Sending back for new patch file

Farnoosh’s picture

Farnoosh’s picture

Status: Needs work » Needs review
Farnoosh’s picture

Farnoosh’s picture

Version: 8.5.x-dev » 8.6.x-dev
mkindred’s picture

#36 works well.

Is 'determinates' a verb? Maybe it should be 'determines'?

Status: Needs review » Needs work

The last submitted patch, 36: tour-user-edit-create-page-2044399-36.patch, failed testing. View results

Farnoosh’s picture

Status: Needs work » Needs review
FileSize
1.61 KB

Status: Needs review » Needs work

The last submitted patch, 42: tour-user-edit-create-page-2044399-42.patch, failed testing. View results

DrupalMattS’s picture

FileSize
2.36 KB

Updated some verbiage and classes to make the tour point to more appropriate areas of the page. Also moved the yml file to the tour module as appearance is not one that can be uninstalled and reinstalled to add the tour configuration.

DrupalMattS’s picture

FileSize
2.36 KB
DrupalMattS’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 45: appearance-tour-2040375-44.patch, failed testing. View results

sjpeters79’s picture

Added a tour of the user page (/admin/people) inside of user/config/optional

mcdwayne’s picture

@ sjpeters79 tested tour-user-edit-create-page-2044399-48.patch

2 issues found:
1) In the 2nd tip, it refers to Language when it should refer to User

I was going to make a patch but there is also another behavior I can't seem to fix so I thought I would bring that up here instead. .

2)
It shows me the number of steps as being 7 instead of 5.

See images
https://i.imgur.com/ZquzEjf.png"

https://imgur.com/5iaRQIW"

mcdwayne’s picture

First time doing this, so forgive me if not correct, happy to fix

Working on both
tour-user-edit-create-page-2044399-42.patch
and
tour-user-edit-create-page-2044399-48.patch

I produced the attached patch.

I separated tour-user-edit-create-page-2044399-42.patch into 2 files, tour.tour.user-create.yml and tour.tour.user-edit.yml for easier customization of each.
I fixed the previously mention issues with tour-user-edit-create-page-2044399-48.patch

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

ridhimaabrol24’s picture

Assigned: Farnoosh » Unassigned
Status: Needs work » Needs review
FileSize
11.55 KB

Rerolled patch for 9.1.x. Added tests for all the 3 pages.
Also removed tour tip for "Roles" on User add and edit page as this is not present in the UserCreateTest and UserEditTest as well. The "Roles" element is not found either on the minimal or the standard profile while running php unit tests.
All the other tips for all the pages can now be seen on the respective pages.
Please review the patch!

Status: Needs review » Needs work

The last submitted patch, 55: 2044399-55.patch, failed testing. View results

ridhimaabrol24’s picture

Status: Needs work » Needs review
FileSize
11.55 KB
1.21 KB

Fixing failed test cases.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

ranjith_kumar_k_u’s picture

FileSize
11.52 KB

Re-rolled #57 for 9.4

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

Status: Needs review » Needs work

D10 version needed
At this time we would need a D10.1.x patch or MR for this issue.

Commit check failures
The last patch doesn't pass commit checks, could you make sure to run ./core/scripts/dev/commit-code-check.sh before uploading a patch to make sure there are no issues with code formatting. see https://www.drupal.org/docs/develop/development-tools/running-core-devel...

_utsavsharma’s picture

Fixed the CCF for #61.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

Component: user.module » tour.module
Status: Needs work » Postponed

This extension is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.

This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.

quietone’s picture

Project: Drupal core » Tour
Version: 11.x-dev » 1.0.x-dev
Component: tour.module » Code
Status: Postponed » Needs work