This issue is to track progress on adding documentation to all source plugins.
This is suitable for a novice.
How to proceed.
- Search the list of source plugins and select a group of source plugins to work on. Priority is given to any group that has a source plugin with a '*' after the file name. Those are the one that use configuration properties.
- Create a child issue
- For the issue summary
- In the Problem/Motivation section use this text, "This issue is to add documentation for the following source plugins." And then add the list of source plugins.
- In the 'Remaining Tasks' section Add what is still left to do, For example, this could be a list of the source plugins that still need documentation.
- For the document
- Use the same style and formatting as was done for the process plugins in the migrate module.
- See #3189587: Add documentation for taxonomy terms source plugins for an example
- Include an
* @see \Drupal\migrate\Plugin\migrate\source\SqlBasewhich has more configuration options.
Refer to API documentation and comment standards for the order of the sections.
If you have any questions, eith leave a comment here or ask in #migration on Drupal Slack.
In progress
Taxonomy and Node - #3209353: Add documentation for remaining node and taxonomy modules
- d6/VocabularyPerType.php
- d6/Vocabulary.php
- d6/VocabularyTranslation.php
- d7/Vocabulary.php
- d7/VocabularyTranslation.php *
- d6/NodeComplete.php
- d6/NodeRevision.php
- d6/NodeType.php
- d7/NodeComplete.php
- d7/NodeRevision.php
- d7/NodeType.php
- NodeCounter.php
- d6/TermNode.php
- d6/TermNodeRevision.php
Remaining items - #3199741: Add documentation for remaining source plugins
-
Aggregator
- AggregatorFeed.php
- AggregatorItem.php
-
Url
- d6/UrlAlias.php
- d7/UrlAlias.php
- UrlAliasBase.php
-
Tracker
- d7/TrackerNode.php
- d7/TrackerUser.php
-
Shortcut
- d7/Shortcut.php
- d7/ShortcutSet.php
- d7/ShortcutSetUsers.php
-
Search
- d6/SearchPage.php
- d7/SearchPage.php
-
Role
- d6/Role.php
- d7/Role.php
-
Profile
- d6/ProfileFieldOptionTranslation.php
- d6/ProfileFieldTranslation.php
- d6/ProfileFieldValues.php
-
Menu
- MenuLink.php
- Menu.php
- d6/MenuLinkTranslation.php
- d7/MenuLinkLocalized.php
- d7/MenuLinkTranslation.php
- d7/MenuTranslation.php
-
Image
- d6/ImageCachePreset.php
- d7/ImageStyles.php
- d7/ResponsiveImageStyles.php
-
Filter
- d6/FilterFormat.php
- d7/FilterFormat.php
-
ViewMode
- d6/ViewModeBase.php
- d6/ViewMode.php *
- d7/ViewMode.php
-
Contact
- ContactCategory.php
- ContactSettings.php
-
Color/Theme
- d7/Color.php
- d7/ThemeSettings.php
-
Comment
- CommentType.php
- d6/Comment.php
- d7/CommentEntityTranslation.php
- d7/Comment.php
-
- Action.php
- Extension.php *
- I18nQueryTrait.php
- UpdateSettings.php
- d7/BlockedIps.php
- d7/RdfMapping.php
- Book.php
- d7/EntityTranslationSettings.php
File - #3189876: Add documentation for file source plugins
- d6/UploadInstance.php
- d6/Upload.php
- d6/File.php *
- d7/File.php *
Done
Migrate and Migrate Drupal - #3206939: Add documentation for Migrate and Migrate Drupal source plugins
Field (d6) - #3200809: Add documentation for d6 field source plugins
Block - #3199742: Add documentation for block source plugins
Language - #3199999: Add documentation for language source plugins
Node - #2937989: Support multiple node types in node source plugins
Taxonomy term - #3189587: Add documentation for taxonomy terms source plugins
User - #3200735: Add documentation for user, profile and roles source plugins
Variable - #3196177: Add documentation for variable source plugins
Field (d7) - #3204986: Add documentation for d7 field source plugins
DrupalSqlBase.php
| Comment | File | Size | Author |
|---|
Comments
Comment #2
Pooja Ganjage commentedHi,
Creating a patch for this issue.
Please review the patch.
Let me know if any suggestions.
Thanks.
Comment #3
Pooja Ganjage commentedComment #4
Pooja Ganjage commentedComment #5
Pooja Ganjage commentedUpdated Patch.
Comment #6
Pooja Ganjage commentedComment #7
matroskeenAdded taxonomy term plugins to "In progress" section due to #3189587: Add documentation for taxonomy terms source plugins.
Comment #8
quietone commented@Pooja Ganjage, thanks for working on this issue. Unfortunately, the patch you have made doesn't meet the criteria in the Issue Summary. Please read that and if you have any questions ask here. Or in #migration on Drupal Slack. This issue will not have a patch, all the work will be in child issues.
@Matroskeen, nice, that is just what I was thinking. A sensible grouping of source plugins in one patch. I haven't done a full review yet.
I also realized that we are not following the coding standards for the order of the sections. I have added a link to the IS for that.
Setting status to NW - lots more child issue to make! :-)
Comment #9
quietone commentedReordered the source plugins loosely by module with some the ones in migrate at the end.
Comment #10
quietone commentedComment #11
quietone commentedUpdated the IS with more detail and tagging as suitable for a novice.
Comment #12
matroskeenAdded link to #3189876: Add documentation for file source plugins.
Comment #13
matroskeenJust some tidy up.
Comment #14
matroskeenAdded two easy ones just to make some progress here.
Comment #15
quietone commentedHaving looked at #3199741: Add documentation for remaining source plugins I am now thinking that maybe we should be flexible in doing this by module. Maybe make a group of very easy ones, where the module only one source plugin or the module has two source plugins, one for d6 and one for d7. It is the same additional to the docs in all those cases and will get a bunch done at one, saving all us time I think.
I rearranged the module list in the IS, making a top priority section, which are the ones that use configuration parameters and probably best done by module. The medium priority list is everything else. It is about 46 (including aggregator) files - is that too many to do in one patch?
Comment #16
matroskeenI think it makes sense to keep simple ones in the same task, let's use #3199741: Add documentation for remaining source plugins to tackle the remaining items.
Comment #17
matroskeenI have one more for review #3199999: Add documentation for language source plugins (issue id is really cool 😎)
Comment #18
matroskeenAdded #3200735: Add documentation for user, profile and roles source plugins.
Comment #19
matroskeenAdded #3200809: Add documentation for d6 field source plugins and made some adjustments
Comment #20
matroskeenAdded #3204986: Add documentation for d7 field source plugins
Comment #21
quietone commentedUpdated IS. Simplified the Done section to just be the issue to make it easier to read.
Comment #22
quietone commentedMove profile
Comment #23
matroskeenI just created an issue to simplify d6_view_modes migration: #3206932: Rename targetEntityType constant in d6_view_mode migration to simplify source plugin. If we land that one, the documentation for view mode plugins should be easy and can go with the remaining items.
Comment #24
matroskeenAdded #3206939: Add documentation for Migrate and Migrate Drupal source plugins
Comment #25
quietone commentedSo far, these have been done by module which has the advantage of focusing the work for the writer of the patch and for the reviewer. And that has been really helpful for fields and blocks. But now that we have established patterns of language I think that there is no need to be strict about doing these by module. For example, it would be silly to have one issue just to do the one source plugin in the Book module. So, from now let's group the work in some reasonable way based on the complexity of the source plugins and the size of the patch.
Comment #26
matroskeenAdded #3209353: Add documentation for remaining node and taxonomy modules and moved #3199741: Add documentation for remaining source plugins back to needs review.
Also reorganized IS to reflect current issues status.
Comment #27
matroskeenSo now all sub-tasks are created and have statuses either Needs Review or RTBC.
Is it the right time to close the meta task? 🧐
Comment #28
quietone commentedThe practice I often see is to close the Meta when all the children are finished or there is only one open. In this case, I think we can be different and close it now. Between the two of us we are keeping this moving and we no longer need the meta to help organize the work. It just adds noise to the issue queue.
Since you did all the work I leave the thrill of closing this to you. I have removed all credit since there is no patch here and this just provided some high level organization.
Comment #29
matroskeen@quietone thank you so much for your quick and encouraging reviews - it kept my motivation and I'm very glad to finish this milestone.
It was also educational because I discovered some plugins I had no idea of.
Happy to close it 🥳