Add API documentation. Make sure that configuration parameters and working with translations are included. Add suitable examples too.
See the documentation in the process plugins for format examples.
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | baa55df03342db29aea486974e8f6c3cb7322e6b859863a2f3e29388450e85a8.jpg | 30.99 KB | phenaproxima |
| #9 | 2862659-9.patch | 1.44 KB | jofitz |
| #9 | interdiff-6-9.txt | 1.42 KB | jofitz |
| #6 | add_documentation_to-2862659-6.patch | 1.53 KB | yogeshmpawar |
| #6 | interdiff-2862659-3-6.txt | 1.44 KB | yogeshmpawar |
Comments
Comment #2
quietone commentedComment #3
jofitzThis one is a bit tricky, but here's a start. I have added:
I couldn't identify destination properties the same as I did with #2862655: Add documentation to Config destination plugin and #2862751: Add documentation to PerComponentEntityDisplay destination plugin.
Comment #4
phenaproximaSelf-assigning for review.
Comment #5
phenaproximaGood start!
Can this say "Provides a generic destination to import entities", or something else a little more illuminating?
I think we'll need to expand quite a bit on this. Also, what happens if the entity type being imported does not support translations?
I'd rather rephrase this to "This will save the processed, migrated row as a node."
I'd like to rephrase this similarly.
Comment #6
yogeshmpawarChanges made as per comment #5.
Comment #7
phenaproximaThanks, @Yogesh Pawar!
This phrasing is weird -- it'll save to a node as a node entity? I think we need to streamline this.
I have to leave this NW because not all my feedback from #5 has been addressed.
Comment #9
jofitzAddressed @phenaproxima's remaining feedback from #5.
Comment #10
phenaproximaComment #11
heddnDo we want to document anything about the entity:node plugin argument? How it auto finds the generic entity plugin and uses the second part as the entity_type?
Comment #12
phenaproximaPersonally, I don't think we need to. There's nothing Migrate-specific about that; it's how derived plugins work. Besides, I think that to Migrate's mainly developer audience, it will be pretty self-explanatory.
Comment #15
larowlanCommitted as 2225b0a and pushed to 8.5.x.