You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@community.apache.org by gi...@apache.org on 2023/05/16 13:23:35 UTC
[comdev-site] branch feature/mailinglist-configuration-staging updated: Updated feature/mailinglist-configuration-staging from feature/mailinglist-configuration at 5dcbaeab2b0f9303d08681d98534786ebfb6bfa9
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch feature/mailinglist-configuration-staging
in repository https://gitbox.apache.org/repos/asf/comdev-site.git
The following commit(s) were added to refs/heads/feature/mailinglist-configuration-staging by this push:
new 703790c Updated feature/mailinglist-configuration-staging from feature/mailinglist-configuration at 5dcbaeab2b0f9303d08681d98534786ebfb6bfa9
703790c is described below
commit 703790c7c65ac92ac33830550cee8ccb2b8a3d73
Author: jenkins <bu...@apache.org>
AuthorDate: Tue May 16 13:23:29 2023 +0000
Updated feature/mailinglist-configuration-staging from feature/mailinglist-configuration at 5dcbaeab2b0f9303d08681d98534786ebfb6bfa9
Built from https://ci-builds.apache.org/job/Community%20Development/job/site/job/feature%252Fmailinglist-configuration/2/
---
content/_pagefind/fragment/en_4c77d95.pf_fragment | Bin 0 -> 3031 bytes
content/_pagefind/fragment/en_562dcbb.pf_fragment | Bin 1606 -> 0 bytes
content/_pagefind/index/en_30236df.pf_index | Bin 0 -> 38741 bytes
content/_pagefind/index/en_397c3c8.pf_index | Bin 0 -> 36079 bytes
content/_pagefind/index/en_46344d1.pf_index | Bin 0 -> 6938 bytes
content/_pagefind/index/en_4ee6bac.pf_index | Bin 0 -> 35905 bytes
content/_pagefind/index/en_5da11ed.pf_index | Bin 42202 -> 0 bytes
content/_pagefind/index/en_5f2e5eb.pf_index | Bin 421 -> 0 bytes
content/_pagefind/index/en_7c893a1.pf_index | Bin 36822 -> 0 bytes
content/_pagefind/index/en_a7d998e.pf_index | Bin 0 -> 40226 bytes
content/_pagefind/index/en_a8488d1.pf_index | Bin 37245 -> 0 bytes
content/_pagefind/index/en_be467ac.pf_index | Bin 36838 -> 0 bytes
content/_pagefind/index/en_cea2deb.pf_index | Bin 39000 -> 0 bytes
content/_pagefind/index/en_f416f7e.pf_index | Bin 0 -> 36582 bytes
content/_pagefind/pagefind-entry.json | 2 +-
content/_pagefind/pagefind.en_3074b91883.pf_meta | Bin 1130 -> 0 bytes
content/_pagefind/pagefind.en_a8e72bf945.pf_meta | Bin 0 -> 1135 bytes
content/contributors/mailing-lists.html | 95 +++++++++++++++++++++-
18 files changed, 95 insertions(+), 2 deletions(-)
diff --git a/content/_pagefind/fragment/en_4c77d95.pf_fragment b/content/_pagefind/fragment/en_4c77d95.pf_fragment
new file mode 100644
index 0000000..2f40cde
Binary files /dev/null and b/content/_pagefind/fragment/en_4c77d95.pf_fragment differ
diff --git a/content/_pagefind/fragment/en_562dcbb.pf_fragment b/content/_pagefind/fragment/en_562dcbb.pf_fragment
deleted file mode 100644
index 33089d8..0000000
Binary files a/content/_pagefind/fragment/en_562dcbb.pf_fragment and /dev/null differ
diff --git a/content/_pagefind/index/en_30236df.pf_index b/content/_pagefind/index/en_30236df.pf_index
new file mode 100644
index 0000000..cf9cd8d
Binary files /dev/null and b/content/_pagefind/index/en_30236df.pf_index differ
diff --git a/content/_pagefind/index/en_397c3c8.pf_index b/content/_pagefind/index/en_397c3c8.pf_index
new file mode 100644
index 0000000..291ebaa
Binary files /dev/null and b/content/_pagefind/index/en_397c3c8.pf_index differ
diff --git a/content/_pagefind/index/en_46344d1.pf_index b/content/_pagefind/index/en_46344d1.pf_index
new file mode 100644
index 0000000..9d1a602
Binary files /dev/null and b/content/_pagefind/index/en_46344d1.pf_index differ
diff --git a/content/_pagefind/index/en_4ee6bac.pf_index b/content/_pagefind/index/en_4ee6bac.pf_index
new file mode 100644
index 0000000..104efb7
Binary files /dev/null and b/content/_pagefind/index/en_4ee6bac.pf_index differ
diff --git a/content/_pagefind/index/en_5da11ed.pf_index b/content/_pagefind/index/en_5da11ed.pf_index
deleted file mode 100644
index 9d3a183..0000000
Binary files a/content/_pagefind/index/en_5da11ed.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_5f2e5eb.pf_index b/content/_pagefind/index/en_5f2e5eb.pf_index
deleted file mode 100644
index 540ea51..0000000
Binary files a/content/_pagefind/index/en_5f2e5eb.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_7c893a1.pf_index b/content/_pagefind/index/en_7c893a1.pf_index
deleted file mode 100644
index 9aca54c..0000000
Binary files a/content/_pagefind/index/en_7c893a1.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_a7d998e.pf_index b/content/_pagefind/index/en_a7d998e.pf_index
new file mode 100644
index 0000000..9a4b02b
Binary files /dev/null and b/content/_pagefind/index/en_a7d998e.pf_index differ
diff --git a/content/_pagefind/index/en_a8488d1.pf_index b/content/_pagefind/index/en_a8488d1.pf_index
deleted file mode 100644
index 1ce6c9f..0000000
Binary files a/content/_pagefind/index/en_a8488d1.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_be467ac.pf_index b/content/_pagefind/index/en_be467ac.pf_index
deleted file mode 100644
index 25d11f6..0000000
Binary files a/content/_pagefind/index/en_be467ac.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_cea2deb.pf_index b/content/_pagefind/index/en_cea2deb.pf_index
deleted file mode 100644
index 967d042..0000000
Binary files a/content/_pagefind/index/en_cea2deb.pf_index and /dev/null differ
diff --git a/content/_pagefind/index/en_f416f7e.pf_index b/content/_pagefind/index/en_f416f7e.pf_index
new file mode 100644
index 0000000..e9bd964
Binary files /dev/null and b/content/_pagefind/index/en_f416f7e.pf_index differ
diff --git a/content/_pagefind/pagefind-entry.json b/content/_pagefind/pagefind-entry.json
index 2df486e..e608c31 100644
--- a/content/_pagefind/pagefind-entry.json
+++ b/content/_pagefind/pagefind-entry.json
@@ -1 +1 @@
-{"version":"0.12.0","languages":{"en":{"hash":"en_3074b91883","wasm":"en","page_count":135}}}
\ No newline at end of file
+{"version":"0.12.0","languages":{"en":{"hash":"en_a8e72bf945","wasm":"en","page_count":135}}}
\ No newline at end of file
diff --git a/content/_pagefind/pagefind.en_3074b91883.pf_meta b/content/_pagefind/pagefind.en_3074b91883.pf_meta
deleted file mode 100644
index 0a2f019..0000000
Binary files a/content/_pagefind/pagefind.en_3074b91883.pf_meta and /dev/null differ
diff --git a/content/_pagefind/pagefind.en_a8e72bf945.pf_meta b/content/_pagefind/pagefind.en_a8e72bf945.pf_meta
new file mode 100644
index 0000000..56aef11
Binary files /dev/null and b/content/_pagefind/pagefind.en_a8e72bf945.pf_meta differ
diff --git a/content/contributors/mailing-lists.html b/content/contributors/mailing-lists.html
index 55669d6..89f52fe 100644
--- a/content/contributors/mailing-lists.html
+++ b/content/contributors/mailing-lists.html
@@ -253,7 +253,100 @@ they appear as a wall of identical subject lines. This makes it hard for
beginners to break into your project, and find out what’s going on.</p>
<p>Here’s some configuration tips for your mailing lists to cut through the
noise and make your project’s lists more approachable and welcoming.</p>
-<p><em>To Be Written</em></p>
+<p>Infra is providing some tooling to implement the automatically sent emails.
+There are generally two important parts:</p>
+<ol>
+<li>Where should stuff be sent</li>
+<li>How should the subject lines be built up</li>
+</ol>
+<p>Both these settings are done in your repositories <code>.asf.yaml</code> file.
+The full documentation of all features are documented <a href="https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features">here</a></p>
+<h3 id="configuring-where-to-send-things">Configuring where to send things <a class="headerlink" title="Permalink" href="#configuring-where-to-send-things">¶</a></h3>
+<p>In order to configure where to send emails, please add or update the
+<code>notifications</code> section in your <code>.asf.yaml</code>.</p>
+<pre tabindex="0"><code>notifications:
+ commits: commits@foo.apache.org
+ issues: dev@foo.apache.org
+ pullrequests: dev@foo.apache.org
+ jobs: dev@foo.apache.org
+ discussions: dev@foo.apache.org
+</code></pre><p>This will sort of make everything go to your <code>dev</code>-list.
+Some projects have sent some of these to other lists, as the amount
+of emails sent from GitHub was too excessive. I will explain in the
+next chapter how to make this flood of emails manageable.</p>
+<p>One thing that might be anoying, expecially for project with many
+third party dependencies, might be that dependabot will also be
+flooding your mailinglist with pretty atomic mini pull-requests.</p>
+<p>In many projects we therefore forward dependabot emails to the
+commits list.</p>
+<pre tabindex="0"><code>notifications:
+ commits: commits@foo.apache.org
+ issues: dev@foo.apache.org
+ pullrequests: dev@foo.apache.org
+ jobs: dev@foo.apache.org
+ discussions: dev@foo.apache.org
+ # Send dependabot PRs to commits@ instead
+ pullrequests_bot_dependabot: commits@foo.apache.org
+</code></pre><h3 id="configuring-the-subject-lines-of-the-emails-being-sent">Configuring the subject lines of the emails being sent <a class="headerlink" title="Permalink" href="#configuring-the-subject-lines-of-the-emails-being-sent">¶</a></h3>
+<p>The defaults that the tooling uses seems a bit odd to me:</p>
+<pre tabindex="0"><code>github:
+ custom_subjects:
+ new_pr: "Created: PR {repository}/#{pr_id}: {title}"
+ close_pr: "Closed: PR {repository}/#{pr_id}: {title}"
+ comment_pr: "Commented: PR {repository}/#{pr_id}: {title}"
+ merge_pr: "Merged: PR {repository}/#{pr_id}: {title}"
+ new_issue: "Created: Issue {repository} {title}"
+ comment_issue: "Commented: Issue {repository} {title}"
+ close_issue: "Closed: Issue {repository} {title}"
+ catchall: "Updated: {repository}/#{issue_id}: {title}"
+ new_discussion: "Created: Discussion {repository}: {title}"
+ edit_discussion: "Edited: Discussion {repository}: {title}"
+ close_discussion: "Closed: Discussion {repository}: {title}"
+ close_discussion_with_comment: "Closed: Discussion with comment {repository}: {title}"
+ reopen_discussion: "Reopened: Discussion {repository}: {title}"
+ new_comment_discussion: "Commented: Discussion {repository}: {title}"
+ edit_comment_discussion: "Edited a comment: Discussion {repository}: {title}"
+ delete_comment_discussion: "Deleted a comment: Discussion {repository}: {title}"
+</code></pre><p>However these result in emails that no email client I have come
+across is able to group to threads and I have not come acoss even one
+email where I got to what the email is about on my phone because all I
+could see was: “Commented: Discuss…”.</p>
+<p>We therefore updated these in some projects to a lot shorter versions:</p>
+<pre tabindex="0"><code>github:
+ custom_subjects:
+ new_pr: "[PR] {title} ({repository})"
+ close_pr: "Re: [PR] {title} ({repository})"
+ comment_pr: "Re: [PR] {title} ({repository})"
+ merge_pr: "Re: [PR] {title} ({repository})"
+ catchall: "Updated: {repository}/#{issue_id}: {title}"
+ new_issue: "[I] {title} ({repository})"
+ comment_issue: "Re: [I] {title} ({repository})"
+ close_issue: "Re: [I] {title} ({repository})"
+ catchall: "[GH] {title} ({repository})"
+ new_discussion: "[D] {title} ({repository})"
+ edit_discussion: "Re: [D] {title} ({repository})"
+ close_discussion: "Re: [D] {title} ({repository})"
+ close_discussion_with_comment: "Re: [D] {title} ({repository})"
+ reopen_discussion: "Re: [D] {title} ({repository})"
+ new_comment_discussion: "Re: [D] {title} ({repository})"
+ edit_comment_discussion: "Re: [D] {title} ({repository})"
+ delete_comment_discussion: "Re: [D] {title} ({repository})"
+</code></pre><p>For some reason, the <code>repository</code> is required to be part of the pattern.
+Moving this to the end made the emails a lot more readable.</p>
+<h3 id="conclusion">Conclusion <a class="headerlink" title="Permalink" href="#conclusion">¶</a></h3>
+<p>The custom templates help make the GitHub content readable on your
+mailinglist it will therefore not feel as overwhelming as with the
+defaults. Moving dependabot to the commits lists, helped reduce the
+content with very little information.</p>
+<p>We would strongly encourage projects to keep as much of the discussions
+on their main mailingslist. If it’s a larger project and still the
+volumne is so high, it’s overwhelming people, think about directing
+some of the content to other lists.</p>
+<p>Simply directing all GitHub content to dedicated mailing lists or
+lists nobody reads doesn’t help with keeping the community knowledge
+available. Even if it’s “on the list” someweere, it doesn’t really
+serve the reasoning behind the “If if didn’t happen on the list,
+it didn’t happen”.</p>
</div>