Problem/Motivation
It can be difficult to understand how to use this module, and for which use cases.
So it would be great if it was documented, with examples for different use cases, including step-by-step instructions on how to set it up.
For inspiration, see @andileco's great example with Charts:
https://www.drupal.org/docs/8/modules/charts/charts-howtos-0/50x-creatin...
> https://www.linkedin.com/posts/daniel-cothran-43878218_drupal-charts-dat...
We could also improve/expand project page documentation adding a bit more text about the module on the project page. This could also help fight a few issues that come up quite often too.
Also, we could add a link to Modules that embed views in fields from the project page.
Steps to reproduce
Need examples on when and how to use the module, and find very few.
Proposed resolution
Improve the documentation, by:
Creating a documentation page
Adding examples under the documentation page
Adding more information about the module on the project page
Linking to Similar modules page
Remaining tasks
Documentation page with examples
- ✅ Create documentation page with information
Create Views Field View documentation page. - ✅ Create examples
Just like Chart has a lot of "How to's" under https://www.drupal.org/docs/8/modules/charts/charts-howtos-0, we could document different ways of using the module under the Views Field View documentation page.- Example by @mortona2k: Event logger: How to show most recent log entry
- Example by @mortona2k: How to list users, and their most recent content (Needs to be added to the Menu)
Everyone should feel free to add even more examples :)
Project page
- ➡️ Add Documentation link under "Resources" section on the project page
Resources
-
➡️ Improve/expand project page documentation
We could add a bit more text about the module on the project page. This could also help fight a few issues that come up quite often too.Also, arguments are from Drupal 6, the concept is now called Contextual filters :)
Similar modules page "Modules that embed views in fields"
-
✅ Add module and description to similar modules page
Information about the module should be added to Modules that embed views in fields. -
➡️ Add link to similar modules page from project page
There should be a link to Modules that embed views in fields on the project page here.
Comments
Comment #2
ressaComment #3
mortona2k commentedExamples were updated.
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...
Comment #4
ressaThanks for the links to the other issues @mortona2k, that was very helpful. I have tried to integrate them into this documentation issue, to consolidate all these documentation tasks into a single issue.
Also, it's great with the info you added on https://www.drupal.org/docs/extending-drupal/contributed-modules/compari...
But perhaps -- as with Event logger: How to show most recent log entry -- those steps could instead be added under a new "How to list users and their most recently edited content" documentation page?
So the text on the comparison page could be something this?
Comment #5
ressaGroup into three tasks.
Comment #6
ressaI went ahead and created a dedicated page for the user list.
I don't have permissions to add it to the menu, probably because new pages in the Guide have been set to "Require review":
Perhaps, it could be considered to relax the permissions, so that other user can also add a new page to the menu, to allow more easily creating documentation?
Comment #7
ressaComment #8
mortona2k commentedI changed the permissions. Thanks for your all your effort in getting things clarified and documented!
Comment #9
mortona2k commentedWe still need to get the docs linked in the project sidebar.
Comment #10
ressaYou're welcome! Thanks for getting it all kick started, with a positive reply and a use case, when I asked in the other issue. If no none had reacted positively, I probably would not have not spent time documenting this great module. It's amazing how far a little good will can go.
And thanks for the permission update, though the menu is still locked for me, for that page ... I do also read that it says "New pages and guides" so perhaps an already created page in fact still need admin intervention ... so perhaps I can ask you to publish it?
And yes, we still have a few more tasks on the project page, like adding a "Documentation" link on the project page, adding a bit more text about the module and a link to the Modules that embed views in fields.
Comment #11
mortona2k commentedI made you an admin and set up the menu.