As a part of #2533684: Create 'Documentation' Section, documentation will be restructured into a set of 'sections', each one of them will be an organic group, with maintainers assigned to take care of the section.
Users need to be able to "follow" a section, and receive email notifications for:
- new content created in the section
- new comments created on the content in the section.
Section maintainers will "follow" their sections automatically.
There needs to be a way to turn following off for some sections (e.g. if it is a top level section of the site).
Following individual pages will be covered at #1304216: A user should be able to "follow" individual pages of content and receive email notifications for new comments, this issue is specifically about following a section (group) of documentation pages.
Deployment
- Allow section & guide content at https://www.drupal.org/admin/structure/flags/manage/project_issue_follow
Update flag_tracker module, cc theme-registry- Update message_follow module
- Update drupalorg module, make sure strongarm picks up flag_tracker & message_follow settings
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | documentation-flags-export.txt | 732 bytes | mgifford |
Comments
Comment #1
mparker17Comment #2
mgiffordComment #3
leehunter commentedMoving to the infrastructure queue. I also wanted to note my comments on the related issue that were specific to documentation: https://drupal.org/comment/7099298#comment-7099298.
Comment #4
shyamala commentedAdding tags
Comment #5
mgiffordSo, we can add a flag for this here:
https://search_api-drupal.redesign.devdrupal.org/admin/structure/flags
Which allows us to Follow/Unfollow documentation pages here:
https://search_api-drupal.redesign.devdrupal.org/documentation/is-drupal...
I haven't figured out how this is brought into the sidebar yet, but...
Drat, I should have just added this here #1304216: A user should be able to "follow" individual pages of content and receive email notifications for new comments
Comment #6
drummDocumentation pages don't fall under the dev tools team, untagging.
Comment #7
drummThis code should live in Drupal.org customizations. Ideally, there shouldn't be a huge amount of custom code. If possible, it could be simplified to a Feature/hook_update_N() to enable & configure contrib modules.
Comment #8
mparker17I got a chance to check out the configuration that @mgifford has done in the sandbox. I also looked at the code in the sandbox to figure out how easy it would be to add e-mail notifications similar to issues. Here are my notes:
Issue subscriptions are done with the flag module: there's a
project_issue_followflag. In the sandbox, it looks like @mgifford has cloned the flag todrupalorg_handbook_followbut changed the bundle restrictions from Issues to Book pages.Looking at the permissions matrix, it appears Documentation Moderators have the "Administer content" role, meaning they can create/edit/delete any node. @LeeHunter, could you clarify which content types would be the most helpful to follow?
For now, I think @mgifford's bundle restriction of Book page makes sense.
Theoretically, we could enable it for all node types (or at least, all that don't say "don't use this anymore"), but I don't know enough about the infrastructure of the site to know if this might cause problems.
Note that "Book Listings" are info about physical, paper books about Drupal, like this one.
In terms of writing a patch, this should indeed be a Feature or hook_update_N().
Adding new things for users to put on their dashboards is easy... any block can be turned into one of those cool little Homebox things by clicking a checkbox.
As for the tabs on the user page, I'll have to do a bit more research... I thought the list of issues flagged by the user was just a view, but the only view I could see that registered the
project/issues/userpath was disabled in the sandbox (and yet the page still works?!?). That being said, the view of projects atproject/userappears to be provided by theproject_issue_user_projectsview, which was enabled as I would have expected. (note the "Your posts" and "Your commits" pages are provided by the core Tracker module).All that being said, it's pretty easy to create a view to do what we want.
In terms of writing a patch, this should be a Feature or hook_update_N() as well.
As far as I can tell, the code to send e-mail notifications is in /project/project_issue">the project_issue module. The code looks like it's fairly tuned towards reporting on issues, so an e-mail notification component will probably end up being custom code.
Based on this information, I think it's worth turning this issue into a meta issue and create a few sub-tasks, so we can get some of the easy-to-implement functionality right away:
Comment #9
mgiffordNice summary Matt. Sorry I wasn't able to join you last night.
Agreed with this being a meta issue. I'll post some stuff for the Follow flag here #1304216: A user should be able to "follow" individual pages of content and receive email notifications for new comments I figure we can just use that one for that part.
We should open up a new one for the email pieces.
EDIT: Remembered that one of the other Content types that needed a follow button was the forum. Strangely I can't seem to find it in a Features export.
Comment #10
drummAlmost, we want configuration exported to
drupalorg_homebox().Issue Views are replaced by drupalorg's
drupalorg_searchapi_issue_viewsFeature. (Longer-term, this should move into Project Issue module itself.)The page and block should be displays from a single View, I'm assuming they will have the same content. Since they are relatively visible, they need some performance checking.
Please look for non-custom solutions that work. Or, the project issue notifications should be simplified into something that can be pulled out into a separate module; for example, #2067659: Send HTML email notification for more compact presentation will make them more general.
Comment #11
jhodgdontagging
Comment #12
mparker17Going to try to tackle this issue during my d.o sprint today.
Comment #13
jhodgdonThanks but... We shouldn't really tackle this issue right now. The Documentation Working Group is currently working on defining the improvements we *actually* want for Documentation. This issue hasn't been updated for a long time and may not fit our goals.
Comment #14
mparker17okay!
Comment #15
dwwGenerally, +1.
Re: e-mail notifications:
We wanted to do that in the D7 port in the first place, and were unable to. See #1560010: [META] Port issue following functionality to D7 and #1560012: Port per-user issue notification email functionality to D7 in all their gory detail. :( Maybe/hopefully the contrib landscape has changed enough since then that we can reconsider, but I'm not too optimistic.
Comment #16
joshuamiComment #17
japerryI'd suggest we look into the follow system that was built for drupal commons. Most of those features could be pulled out and into drupal.org.
Comment #18
cilefen commented+1 Some pages, like https://www.drupal.org/core/beta-changes and https://www.drupal.org/core-mentoring/novice-tasks are important to contribution mentors and I have not idea if they have changed except by using a 3rd-party service.
Comment #19
tvn commentedWe'll be working on this as a part of implementation of the new Documentation Section. Updating issue summary.
Comment #20
drummComment #22
drummStarting deployment notes in issue summary
Comment #23
drummComment #24
drummI'm building this out at https://follow-drupal.dev.devdrupal.org/drupalorg/docs
To do:
Add something to configure special entity reference fields
Show that you are following a guide when you are on a page
Send emails for new pages
Send emails for page when following guide
Check over email formatting
Comment #25
drummThe dev site is nearly complete for this.
To do:
Comment #26
drummSample emails to be sent:
New page or guide
New comment
Comment #28
drummI deployed the update to flag_tracker module, which was all code cleanups, no substantive changes specifically for this issue.
Comment #30
drummPreliminary work in drupalorg that is deployable is now deployed. This is the From address customization and Panels configuration. While the Follow button is added to Guides and sections now, it won't show until configured with the main deployment.
Comment #32
drummThis has been deployed.