Project messaging channel in core (as experimental)

Making a short comment for now, before I try to summarize in the issue summary what was still outstanding:

• Color of the red button- which is fixed and waiting on final review confirmation
• Tests were not passing - fixed
• Demo needs to show more items - fixed in the current DrupalPod
• First post feedback needs to be resolved - still outstanding, assigned to @hestenet
• Json format needs to be refactored - ✨ Make announcements json feed format consistent with https://www.jsonfeed.org/version/1.1/. Fixed

When those are complete, we set to 'Needs Review' and make sure all of the 'needs_accessibility_review' and 'needs_usability_review' etc type tags get signed off and removed. Then we move to RTBC, and can get a committer to finish this off. :)

Follow up from #153:

• ✅ Color of the red button - fixed and waiting on final review confirmation
• ✅ Tests were not passing (still running while I'm writing this)
• ❌ Demo needs to show more items - need to do a new snapshot and update links.
• ❌ First post feedback needs to be resolved - still outstanding, assigned to @hestenet
• ✅ Json format needs to be refactored: refactored here on this MR and ✨ Make announcements json feed format consistent with https://www.jsonfeed.org/version/1.1/. Fixed pending review and deployment.

https://www.drupal.org/announcements.json → now has the placeholder in the jsonfeed format. I think the next most important thing is to get real content into the feed, updated on a regular basis, as if this were in production.

Pending the addition of some links, and a decision about whether to include a survey in the first post, the other feedback about the 'first post' has been addressed: https://docs.google.com/document/d/1d5Uq1ORQDy5bW_3WAyyorEVuHCtZBBB_aKMt...

Could the reviewers who reported these issues confirm the fixes?

✅ Color of the red button - fixed and waiting on final review confirmation
- Reviewer: @mherchel
✅ Tests were not passing (still running while I'm writing this)
- Reviewer: The bot tells us this one :)
✅ Demo needs to show more items - it points to the test data.
- Reviewer: @
🟡 First post feedback needs to be resolved - still outstanding, assigned to @hestenet
- Reviewer: @Gábor Hojtsy
✅ Json format needs to be refactored: refactored here on this MR and ✨ Make announcements json feed format consistent with https://www.jsonfeed.org/version/1.1/. Fixed
- Reviewer: @

From there, I think I need to reach out to the right people to clear our current issue tags:

• Needs accessibility review
• Needs framework manager review
• Needs product manager review

And then after all that:

• Needs release manager

✅ Demo needs to show more items - it points to the test data.
- Reviewer: @catch

Unless I'm missing something, I don't think #129 is addressed.

I can still only see one post on https://www.drupal.org/announcements.json → - it is saying that something is about to be added to core.

If this is merged into core as experimental, then we do not want an announcement that something is going to be added to core, because it'll already be in core, so the information will be at best outdated, at worst confusing/misleading. I

The feed should have actual relevant announcements for someone who would test the experimental module, before it's committed, so that they're immediately available once it is. And then part of the process of getting this to stable/adding it to standard/umami would be that those announcements continue to be up-to-date on whatever we think a reasonable schedule is. It's the first time we've added something to core that has an actual content dependency on Drupal.org, except maybe update status in a way, and once it's on sites, unless they uninstall it, core releases can't do anything about the contents of the feed.

Reviewed the suggested first post in the google doc, I still have doubts about the survey, see there. I made a couple suggestions to parts that were not yet done.

✅ Json format needs to be refactored: refactored here on this MR and ✨ Make announcements json feed format consistent with https://www.jsonfeed.org/version/1.1/. Fixed
- Reviewer: @longwave

The changes for this on both sides mostly look good. However, reading the JSON Feed extensions spec again I have a couple of comments:

For instance, imagine a podcast directory service — call it Blue Shed Podcasts — that asks a podcaster to specify some additional information about a feed or item. A publisher would do something like this:

"_blue_shed": {
    "about": "https://blueshed-podcasts.com/json-feed-extension-docs",
    "explicit": false,
    "copyright": "1948 by George Orwell",
    "owner": "Big Brother and the Holding Company",
    "subtitle": "All shouting, all the time. Double. Plus. Good."
}

The about string is there for a human looking at the feed, so they can understand what goes in the custom extension. It’s optional, but it should appear at least once in a feed that may contain multiple uses of _blue_shed (preferably in the first use, but that’s not required).

Also, it’s good practice to name an extension with a company or service name, to provide a clue right away as to what it’s for and who made it.

Our extension is currently named _extra which isn't very descriptive. I think the extension should be named _drupal or _drupal_org and we should consider an about key that links to a relevant URL - I feel strongly about the former but not so strongly about the latter; we can't easily change the extension key later, but we could add the about element at any time in the future.

Addressed #162 here https://www.drupal.org/project/drupalorg/issues/3336530#comment-14912886 ✨ Make announcements json feed format consistent with https://www.jsonfeed.org/version/1.1/. Fixed . I named it "_drupalorg" as that's more consistent with the naming we use in the code all over, but happy to change it as needed.

Thanks for the swift update - _drupalorg is better if that's consistent, no further comments from me on the JSON Feed side of things.

Comments #160 and #161 both make sense to me.

Re: #160 - some specifics: The module has a test fixture which shows what something like 8-10 different types of posts would look like, just so you can see what a more full feed would look like that way. However, I can start to build more posts into the live feed, even if it isn't really in use yet... speaking of which....

Re: #161 - I think I'll take out the survey concept in the first post entirely, and just put up a post which explains the lay of the land. Then I'll look into trying to get 2 or 3 more posts together, either appropriate reposts about project news from the core news feed, or unique posts.

The issue with the red text being inaccessible is fixed (the red was removed)

One more issue that I noticed:

The date is currently formatted MM/DD/YYYY. However that's an americanism. Most of the world (I believe) uses DD/MM/YYYY. In Olivero, we sidestepped the issue by having a date like " 2 April, 2021".

We should also remove the leading zero from the time, and add AM/PM etc.

Thoughts on all of this?

I support 100% using complete name for the month, not two digits, like " 2 April, 2021". @fgarlin, how difficult would it be make this change?

The date is currently formatted MM/DD/YYYY. However that's an americanism. Most of the world (I believe) uses DD/MM/YYYY.

It seems to me that the pattern of the date format (currently "short") depends on the UI settings. Sites that have this set up to DD/MM/YYYY should have also this date formatted the same:

  <div class="announcement__date">{{ announcement.timestamp | format_date('short') }}</div>

Correct, it will adapt to the set up of the site, following the "short" date format. So nothing to do on that end I assume.

Have we established any governance or process around what messages will appear in the feed?

@AaronMcHale:

• This was the issue for the governance process, which Dries ultimately approved: #3071994: Document approval process for what appears in the official Drupal project messaging feed →
• And that was documented here: https://www.drupal.org/docs/core-modules-and-themes/core-modules/announc... →

Spun off a child issue for approval of the first post: #3343263: Approve first project announcement in core post →

Will follow this up with 2 or 3 additional posts per @catch's feedback to have multiple relevant posts during the experimental phase for this module.

First post was published: #3343263: Approve first project announcement in core post →
https://www.drupal.org/about/announcements/blog/what-to-expect-from-the-... →
And is available in the feed:
https://drupal.org/announcements.json

Per @catch's feedback, the last remaining todo(apart from any final code review) is to have 2 or 3 more posts so it's not quite so empty when committed.

The last outstanding item was requested by @catch - to create 3 initial posts.

Those posts are complete, and available in the feed: https://drupal.org/announcements.json

In accordance with the governance process the issues for each were:
#3343263: Approve first project announcement in core post →
#3345037: Draft second project announcements "Contribute to Drupal and the Open Web" →
#3345573: Cross-post and backdate the Drupal 10.0.0 announcement to the project announcements feed. →

I did notice we are using date modified rather than date created in the feed - we may want to change that: 🐛 Announcement Feed uses modified date rather than date created Fixed

Once that is resolved, hopefully someone can RTBC :)

Installed the module without issue
I see that off canvas opens without issue

For accessibility
When the off canvas opens focus goes to the first item.
Tabbing stays within the office canvas (3 items and X button)
Pressing X with keyboard closes off canvas and puts focus back on the announcement link.

NOT sure if there needs to be any kind of announcement made in drupal-live-announce

If not +1 from me. But needs product, framework, release manager reviews too.

Follow up from #177:
* 🐛 Announcement Feed uses modified date rather than date created Fixed is ready to review + deploy
* Changes to ready from that new property made in the last commit: https://git.drupalcode.org/project/drupal/-/merge_requests/2889/diffs?co...

Cleaning up the tags to the ones I think are left. I was cleared to remove the other tags once the found issues from the last comments were resolved.

• Product manager review - @Gabor Hojtsy has been the closest, so hopefully can +1
• Framework manager review - @catch has given feedback, but since he's also the likely release manager, maybe @larowlan or @effulgentisa could give us a sign off on this one.
• Release manager review - I think this will be @catch based on activity so far.
• Release notes snippet is already included in the issue summary
• Drafting a change record will need to happen.

We still need follow-up issues for the usability review in comment #116. Specifically, moving the feed to be within a dashboard.

There is currently work going on to propose an initiative for Dashboards in Core. The toolbar approach still does not sit well with me, and adding the feed to a Dashboard would be a much better place to present this information.

It's probably fine for this to go in as experimental using the toolbar approach, but we should be clear that the toolbar approach may only be a temporary solution.

For anyone interested in learning more about Dashboards, feel free to join us in the #dashboard channel on Drupal Slack, and the Core Ideas issue which sets out some of the initial approach 🌱 Enhance user experience with customizable dashboards Active .

I wanted to try this once again. I did all the steps from the issue summary to do testing. It still says

cURL error 60: SSL: no alternative certificate subject name matches target host name '8080-shaal-drupalpod-050qz7bqbvl.ws-eu86.gitpod.io' (see https://curl.haxx.se/libcurl/c/libcurl-errors.html) for https://8080-shaal-drupalpod-050qz7bqbvl.ws-eu86.gitpod.io/core/modules/...

So it appears like the change does not actually take effect.

That seems to be a drupalpod issue. I'm following up on the #drupalpod channel. Any chance you can create a brand-new environment? I just created a new one and I don't get the certificate issue when making the URL public. We can continue debugging via slack if you want too.

Edited issue summary after @fjgarlin let me know where was my misunderstanding.

Also now that I have tested with the live feed, this is what I get in Chrome. The "New" marker running over the text is not good. And the order of items with the different order of dates is odd. Is this intended?

I can look into both things.

Both of the reported issues have been addressed. Note that that the snapshot URL is new.

I tested on a new snapshot and it works correctly for me, thanks! Ready to change to RTBC :)

Resizing the off-canvas I was able to get the overlap still.

Thanks for the additional testing @smustgrave. TIL that you can resize the off-canvas! I didn't know that.

I see two options:
1) Remove the absolute positioning of the "New" word and just place it after the title.
2) Assign a fixed width to the title so it never overlaps with the "New" word.

For option 2, it'd need to be at least a 80%/20% which does not look nice, so I'm going to do option 1.

Once done, I'll update the snapshot and make a comment here.

#189 feedback has been now addressed. I've updated the snapshot URL in the issue description and this is ready for a new round of review(s).

In response to #116/#181 - I've opened:

• 📌 Convert announcements feed from toolbar to dashboard Postponed

It is postponed until the dashboard model itself is scaffolded out.

We are back to:

• Product manager review - @Gabor Hojtsy
• ✅ Fran has resolved the display issue found in your and @smustgrave's review
• Framework manager review - @catch has given feedback, but since he's also the likely release manager, maybe @larowlan or @effulgentisa could give us a sign off on this one.
• Release manager review - I think this will be @catch based on activity so far.
• ✅ Release notes snippet is already included in the issue summary
• 🟡 Drafting a change record - started one here: https://www.drupal.org/node/3349399 →

Left a review, the main issue here is that all pages become uncacheable with Dynamic Page Cache when you enable this module, by way of the user cache context.

I am going to start working on the easier bits of the review.

Oh, I broke the tests. :-(

Also, when I converted to constructor property promotion PHPStan through errors of the form "Constructor of class Foo has an unused parameter $bar".

One thing I do find confusing is that this is only place I know of where the pencil icon is used and it is not something that I can edit.

I have done all the easier, non frontend, bits of larowlan's review that I can. I'll step back now and let others continue.

One more thing, Can we change the module name to just 'announcements'? I found it mildly annoying to have such a long name while I working on this. Or why is '-feed' needed?

Rishabh Vishwakarma → made their first commit to this issue’s fork.

@quietone - The module was renamed due to (potential) collision with other library, see comments #27, #36, #40.

Pushed a lazy builder and a test to ensure we're cacheable (We previously were making all pages uncacheable with DPC)

Reposting the current reviews that are needed.

• ✅ Fran has resolved the display issue found in your and @smustgrave's review
• Framework manager review - @larowlan has provided a bunch of feedback (along with @quietone) - @fjgarlin believes this has all been addressed - can the threads be resolved and framework review be signed off?
• Product manager review - @Gabor Hojtsy - when the above is signed off, can we get your formal sign off?
• Release manager review - I think this will be @catch based on activity so far?
• ✅ Release notes snippet is already included in the issue summary
• 🟡 Drafting a change record - started one here: https://www.drupal.org/node/3349399 →

There is no framework manager feedback pre-requisite to product manager reviews in Drupal. As a product manager, I already provided detailed feedback on the sample posts and my feedback on the UI were all addressed, so we should be good to remove the tag. :)

Thanks, Gábor! And thanks for the context on order of operations. Even after all these years I know I don't always get the details right.

@larowlan and then @catch, I think you're up!

Re comment #198

One thing I do find confusing is that this is only place I know of where the pencil icon is used and it is not something that I can edit.

I agree, pencil is probably not the right icon as it generally implies you can edit something by clicking/tapping it.

@poker10, thanks for answering my question about the name, 'Announcements Feeds'. That makes sense to avoid conflicts.

I resolved the few issues I could. That is things I did not work on and were not front endy. I also made

However, I think the user will think of this as just 'Announcements' and that 'Feed' is not needed. For example, right now I am looking at the help page which uses 'Announcements Feed' while in the upper right hand corner I see 'Announcements'. Personally, I find that jarring. But my personal view aside would it not be better for them to be the same?

That icon should probably be the bell shown in comment #184 ✨ Project messaging channel in core (as experimental) Fixed

@quietone - as long as the machine name remains announcements_feed - I think the display text could be 'Announcements' to address the confusion you are talking about

Maybe @fjgarlin can take care of these nits, and we can bounce back to last reviewers.

I will action those two items my tomorrow morning and update the gitpod link once done.

@hestenet, Yes, that is what I was thinking.

As someone who has not followed this at all I thought I'd try this out. First of all the MR needs a rebase. If you install from 10.1 HEAD and switch to this branch you'll get a WSOD. A fresh install from this branch works fine.

Once that was resolved I installed the module and visited the help page to find out what to do next. It suggested that if I had permission I could click the "Announcements" button in the admin toolbar and otherwise guided me to the online help page. I could not for the life of me fine the Announcements button so I started stepping through with a debugger to see if it was working. Anyway, lo and behold, the Announcements button was there in the top right corner the whole time, I guess I was just focusing on the left hand side.

While this seems really obvious now, and I feel silly for taking so long to find it, perhaps we could get a screenshot added to the online help page so we know what to expect?

@mstrelan - we are rebasing regularly but sometimes it's hard to be on top of it, especially if we are waiting for reviews. Having said that, I just rebased the MR so thanks for mentioning it.

After your comment, I thought about adjusting slightly ("...situated in the top right...") the language or adding a screenshot, but the position of the "Announcements" link might change for users with RTL, so I left it as it is for now, but I'm happy to adapt as needed if there are some suggestions that people agree on.

I think the two main release management points, the feed format and having some realistic contents for testing are now covered, so we're down to regular review points rather than sign-offs as such here.

Is there a meta issue with issues required for beta and stable?

I grepped core for 'sites users' and there were less than five. The help pages and module descriptions use 'users', so I changed the text.

All the new feedback has been addressed. I also believe that all the older threads are fully addressed. I've pinged people in slack about it too.

The current thread situation is:
- @mherchel: 4 threads
- @larowlan: 3 threads
- @alexpott: 2 threads
- @quietone: 1 thread
- @DanielVeza: 1 thread
- @fjgarlin: 1 thread (I can't resolved it - permissions)

If those threads can be resolved or commented on that'd be great so we can keep moving forward and we know what else might be needed.

I've also updated the gitpod snapshot in the issue description.

I read trough the PR and looked at the test coverage and couldn't find anything that needs looks like it still needs changing.
Everything seems to be well documented as well.

I added a basic version of the change record, but that should be completed with more information.

Some minor items on the MR

I've created follow-ups and 📌 Mark Announcements Feed as stable Fixed where everything can be tracked.

All the threads were resolved and follow-ups were created were necessary (thanks @alexpott). Marking this as NR.

We've reviewed the code extensively and the theming and markup has been reviewed by front end experts too. We have the follow-ups in place and we have a CR. I think the final MR represents a great first step from where we can build more user centred functionality for marking as read or implementing into the new dashboard initative.

I'm not sure if this should go in as beta or as alpha. As it stands I don't think that this module offers an API. All classes are final and marked as @internal. Things can be opened up in beta or once this module as stable as necessary. Maybe someone can open an issue to discuss this - similar to 📌 Mark SDC as beta so it can be included in 10.1 Fixed

Saving issue credits; apologies if I missed anyone, but as usual with long issues it is hard to get this completely right.

Committed and pushed 492062df7c to 10.1.x. Thanks!

Also updated the change record and published it.

Incredibly thankful to everyone involved in making this happen. Thank you, everyone!

We should add project browser to https://www.drupal.org/about/core/policies/core-change-policies/experime... →

@catch I already added it to the first table after committing.

Oops my brain didn't make the connection between 'project messaging' and 'announcements'.

Next question then - should we add a new core component?

I think we shoul add a new component. Should it be 'announcements' or would that be confusing as well? (Make it 'project annoucements' instead or would that would confusing in another way?)

Agree with adding a component, it should probably just be "announcements_feed.module"?

Ah good point. Added :)

Adjusting credit as credit is not granted for just pressing the rebase button in Gitlab.

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

Thanks everyone, very cool!

I created ✨ Show list of announcements, at least once or by default, and turn on/off in a setting Closed: won't fix to make sure that it doesn't get missed.