Problem/Motivation

This issue is to add documentation for the following source plugins:

  • d6/User.php
  • d6/UserPictureFile.php *
  • d6/UserPicture.php
  • d7/UserEntityTranslation.php
  • d7/User.php
  • UserPictureInstance.php
  • ProfileField.php
  • d6/ProfileFieldOptionTranslation.php
  • d6/ProfileFieldValues.php
  • d6/ProfileFieldTranslation.php
  • d6/Role.php
  • d7/Role.php

Proposed resolution

Documentation is helpful. Let's do that.

Remaining tasks

merge request, review, commit.

Issue fork drupal-3200735

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Matroskeen created an issue. See original summary.

Matroskeen’s picture

Title: #3199742: Add documentation for user source plugins » Add documentation for user source plugins
Issue summary: View changes

Matroskeen’s picture

Title: Add documentation for user source plugins » Add documentation for user, profile and roles source plugins
Issue summary: View changes
Status: Active » Needs review

Given that we decided to combine all simple plugins into one task, I think it's fine to include more plugins into separate tasks.

That's why I expanded the scope here and included all plugins from user module + d6/ProfileFieldTranslation.php, which is located in config_translation. By the way, is there any reason for this plugin to be there?

@quietone, this is ready for the review :)


I also noticed something interesting here. Those two plugins seem identical to me:

d6/UserPicture.php
d6/UserPictureFile.php

Although the code is slightly different, I don't really understand the difference. I also was trying to find the usage of d6_user_picture, but no luck. It makes me think that d6_user_picture should be deprecated, but I want someone to double-check.

quietone’s picture

Status: Needs review » Reviewed & tested by the community

I support doing all the user module source plugins in one go.

The translation migrations are in config_translation or content_translation so they are not found during discovery. They will only be available when translation is enabled.

Nice find on d6_user_picture and d6_user_picture_file. I grepped for d6_user_picture and also did not find any occurrences of it. I think it is safe to deprecate it. It could be a child of the meta, #3010983: Deprecate Drupal 6 and Drupal 7 migrations and move to contrib. But it doesn't need to be postponed, we know it is not being used.

I applied the patch and read the changes for each plugin. At first I was surprised by this change, which remove 'Gets' from the summary line. (Can't seem to link to the change and copy/paste doesn't work well.)

 * Gets i18n strings profile field source from database.
 * Drupal 6 i18n strings profile field source from database.

But looking the other plugins this just makes them all consistent, which I support. They may only be in that form in this module and I think that is fine, there is no need to make every single source plugin have the same style of summary line.

@Matroskeen, thanks, another lot done.

Matroskeen’s picture

  • catch committed 38a40a2 on 9.2.x
    Issue #3200735 by Matroskeen, quietone: Add documentation for user,...
catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed 38a40a2 and pushed to 9.2.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.