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

  1. Allow section & guide content at https://www.drupal.org/admin/structure/flags/manage/project_issue_follow
  2. Update flag_tracker module, cc theme-registry
  3. Update message_follow module
  4. Update drupalorg module, make sure strongarm picks up flag_tracker & message_follow settings
CommentFileSizeAuthor
#5 documentation-flags-export.txt732 bytesmgifford

Comments

mparker17’s picture

Issue summary: View changes
leehunter’s picture

Project: Drupal.org customizations » Drupal.org infrastructure
Version: 7.x-3.x-dev »
Component: User interface » BZR

Moving 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.

shyamala’s picture

Issue tags: +Needs DSWG Dev Tools Team feedback

Adding tags

mgifford’s picture

StatusFileSize
new732 bytes

So, 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

drumm’s picture

Issue tags: -Needs DSWG Dev Tools Team feedback

Documentation pages don't fall under the dev tools team, untagging.

drumm’s picture

Project: Drupal.org infrastructure » Drupal.org customizations
Version: » 7.x-3.x-dev
Component: BZR » Code

This 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.

mparker17’s picture

I 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_follow flag. In the sandbox, it looks like @mgifford has cloned the flag to drupalorg_handbook_follow but 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/user path was disabled in the sandbox (and yet the page still works?!?). That being said, the view of projects at project/user appears to be provided by the project_issue_user_projects view, 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:

  1. Clone the "Follow" flag currently used on issues for book pages. Add a view so it can show up on users' dashboards / as a tab on their user page. (this looks fairly straightforward)
  2. Write the code to let users pick how often they get notified by e-mail, and send e-mail notifications notified. (this looks a little more complicated)
mgifford’s picture

Title: Notify authors, contributors and/or interested users about changes to documentation pages » [META] Notify authors, contributors and/or interested users about changes to documentation pages

Nice 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.

drumm’s picture

any block can be turned into one of those cool little Homebox things by clicking a checkbox.

Almost, we want configuration exported to drupalorg_homebox().

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/user path was disabled in the sandbox (and yet the page still works?!?). That being said, the view of projects at project/user appears to be provided by the project_issue_user_projects view, which was enabled as I would have expected. (note the "Your posts" and "Your commits" pages are provided by the core Tracker module).

Issue Views are replaced by drupalorg's drupalorg_searchapi_issue_views Feature. (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.

As far as I can tell, the code to send e-mail notifications is in 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.

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.

jhodgdon’s picture

Issue tags: +docs infrastructure

tagging

mparker17’s picture

Assigned: Unassigned » mparker17

Going to try to tackle this issue during my d.o sprint today.

jhodgdon’s picture

Thanks 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.

mparker17’s picture

Assigned: mparker17 » Unassigned

okay!

dww’s picture

Generally, +1.

Re: e-mail notifications:

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;

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.

joshuami’s picture

Issue tags: +d.o content strategy
japerry’s picture

I'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.

cilefen’s picture

+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.

tvn’s picture

Title: [META] Notify authors, contributors and/or interested users about changes to documentation pages » A user should be able to "follow" a Section of content
Issue summary: View changes
Issue tags: -docs infrastructure, -d.o content strategy +drupal.org documentation
Parent issue: » #2533684: Create 'Documentation' Section

We'll be working on this as a part of implementation of the new Documentation Section. Updating issue summary.

drumm’s picture

Assigned: Unassigned » drumm

  • drumm committed ca1d1f0 on 7.x-3.x
    Issue #2218551: Add field_documentation_changes to comment notifications
    
drumm’s picture

Issue summary: View changes

Starting deployment notes in issue summary

drumm’s picture

Issue summary: View changes
drumm’s picture

I'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

drumm’s picture

Status: Active » Needs review

The dev site is nearly complete for this.

To do:

  • Add guide following information to the comment notification email
  • Check over email formatting
drumm’s picture

Sample emails to be sent:

New page or guide

From: "drumm (follow drupal dev)" <noreply@drupal.org>
To: 7813258ef8c6b632dde8cc80f6bda62f@sanitized.invalid
Subject: [Documentation page] Yet another new page

drumm created a new Documentation page:

Yet another new page

This is the summary, testing out notifications.

View on follow drupal dev:
https://follow-drupal.dev.devdrupal.org/drupalorg/docs/content/a-guide/yet-another-new-page

--
You received this message because you are following Drupal.org documentation.
Manage notifications at
https://follow-drupal.dev.devdrupal.org/user/717216/message-follow

To unsubscribe from notifications about this content, go to
https://follow-drupal.dev.devdrupal.org/drupalorg/docs and click
“Unfollow”. (And make sure you are logged in.)

New comment

From: "drumm (follow drupal dev)" <noreply@drupal.org>
To: 7813258ef8c6b632dde8cc80f6bda62f@sanitized.invalid
Subject: [Documentation page] Yet another new page

Status:  » Incomplete

drumm commented:
This could use some work.

View on follow drupal dev:
https://follow-drupal.dev.devdrupal.org/drupalorg/docs/content/a-guide/yet-another-new-page#comment-11391561

--
You received this message because you are following Drupal.org documentation.
Manage notifications at
https://follow-drupal.dev.devdrupal.org/user/717216/message-follow

To unsubscribe from notifications about this content, go to
https://follow-drupal.dev.devdrupal.org/drupalorg/docs and click
“Unfollow”. (And make sure you are logged in.)

  • drumm committed 603e673 on 2218551-follow-section
    Issue #2218551: Configure message type for new page notifications
    
  • drumm committed 9a94146 on 2218551-follow-section
    Issue #2218551: Add Follow to sections
    
  • drumm committed b48a50d on 2218551-follow-section
    Issue #2218551: Handle from address rewriting for messages about a node
    
  • drumm committed ca1d1f0 on 2218551-follow-section
    Issue #2218551: Add field_documentation_changes to comment notifications
    
  • drumm committed f95646b on 2218551-follow-section
    Issue #2218551: Move Follow to the bottom of pages, add to guides
    
drumm’s picture

Issue summary: View changes

I deployed the update to flag_tracker module, which was all code cleanups, no substantive changes specifically for this issue.

  • drumm committed 9a94146 on 7.x-3.x
    Issue #2218551: Add Follow to sections
    
  • drumm committed b48a50d on 7.x-3.x
    Issue #2218551: Handle from address rewriting for messages about a node
    
  • drumm committed f95646b on 7.x-3.x
    Issue #2218551: Move Follow to the bottom of pages, add to guides
    
drumm’s picture

Preliminary 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.

  • drumm committed 603e673 on 7.x-3.x, dev
    Issue #2218551: Configure message type for new page notifications
    
drumm’s picture

Status: Needs review » Fixed

This has been deployed.

Status: Fixed » Closed (fixed)

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