Arch Coordination - How to announce and tune-in
Where, when, which channels?
Intentionally Not Covered
A rubric for how to calculate impact.
Urgent Communication
Impacted Party (Not Where It’s Implemented) | Level of Change | GitHub Issues/PRs | Slack | Potential Rituals | Discourse Post |
|---|---|---|---|---|---|
Limited to a Specific Repo | Small/Medium/Large | As an issue on the Repo(as codified by the Maintainers OEP) |
|
|
|
Some Open edX developers | Small |
| Subject-relevant slack channel if it exists. Domains And Their Slack Channels: |
| Maybe (Development-> Architecture) |
| Medium/Large |
| #architecture - Open edX | Core Contributors Meetup | Yes (Development-> Architecture) |
All Open edX developers | Any |
| #architecture - Open edX Subject-relevant slack channel like:
| Core Contributors Meetup | Yes (Development-> Architecture) OEPs gets announced in a different place. |
Content Acceptance Criteria
Ensure your communication answers the following questions:
Make sure all the details live in one place and all your announcements should link to that place.
Your details should have a summary that you can copy paste everywhere.
Be clear about where you want the discussion to happen.
For example, if you’re announcing in Slack and Discourse, but you want the discussion on the OEP pull request.
Is there a clear call-to-action? If so, what is it?
How does this impact the reader?
What are the “outcomes” that are planned/completed (as opposed to “activities” planned/completed)?
(Optionally) How will these outcomes be measured?
How/where can the reader follow-up with questions/feedback/etc?
Tips for tuning-in
In general, review the announcing table and configure notifications that work for you. This may include joining the listed Slack channels, or getting notified from GitHub or Discourse. There is also a Google Group. See the following tips for more details.
Notifications for Discourse Posts
Click the relevant “Discourse Post” link from the announcement table that you wish to watch.
Click the notification button with the bell icon, and choose “Watching First Post”, or your favorite option. This should watch an entire category of posts.
If you choose “Watching First Post”, and get notified about a post you want to continue to watch, us Visit Topic and again add a watch using the notification button with bell icon.
Also, under email preferences (
https://discuss.openedx.org/u/<username>/preferences/emails)Choose “always” in place of “only when away” if you want more consistent email notifications.
ADR-ish notifications
There is a google group https://groups.google.com/g/adr-notifications that you can subscribe to to get emails from adr-notifications@googlegroups.com with notices about any doc related changes, like ADRs, OEPs, etc.
Times When This Table Was Not Helpful
Who are you? | Context on Why It was Not Helpful |
|---|---|
|
|
|
|
Examples of Different Announcements
Impacted Party | Level Of change | Details of the Communication that Happened |
|---|---|---|
|
|
|
|
|
|