diff mbox series

MyFirstContribution: update mailing list sub steps

Message ID pull.1644.git.1705697955144.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series MyFirstContribution: update mailing list sub steps | expand

Commit Message

Kyle Lippincott Jan. 19, 2024, 8:59 p.m. UTC
From: Kyle Lippincott <spectral@google.com>

The documentation says to send an email to majordomo. Doing so gets you
an auto response saying majordomo has been turned down, and to instead
visit https://subspace.kernel.org/vger.kernel.org.html and use the
sub/unsub links.

Update the instructions to reference the supported mechanism for
subscribing to the git mailing list. Include details like these being
mailto links but the subject/body aren't necessary, since it's not
obvious what to put in those fields.

Signed-off-by: Kyle Lippincott <spectral@google.com>
---
    MyFirstContribution: update mailing list sub steps

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1644%2Fspectral54%2Fmy-first-contribution-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1644/spectral54/my-first-contribution-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1644

 Documentation/MyFirstContribution.txt | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)


base-commit: a54a84b333adbecf7bc4483c0e36ed5878cac17b

Comments

Konstantin Ryabitsev Jan. 19, 2024, 9:06 p.m. UTC | #1
On Fri, Jan 19, 2024 at 08:59:15PM +0000, spectral via GitGitGadget wrote:
>  contributing are welcome to post questions here. The Git list requires
>  plain-text-only emails and prefers inline and bottom-posting when replying to
>  mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
> -the list by sending an email to majordomo@vger.kernel.org with "subscribe git"
> -in the body. The https://lore.kernel.org/git[archive] of this mailing list is
> -available to view in a browser.
> +the list by visiting https://subspace.kernel.org/vger.kernel.org.html and using
> +the `sub` link next to the `git` list (this is a mailto link; you can leave
> +subject and body blank, but you still have to send the email). The

I recommend just telling people to send a message to
git+subscribe@vger.kernel.org and linking to
https://subspace.kernel.org/subscribing.html for more details. While
"sub/unsub" links will do the job for some people, webmail users may not
have things properly configured to correctly process the mailto: links.

-K
Junio C Hamano Jan. 19, 2024, 10:26 p.m. UTC | #2
Konstantin Ryabitsev <konstantin@linuxfoundation.org> writes:

> On Fri, Jan 19, 2024 at 08:59:15PM +0000, spectral via GitGitGadget wrote:
>>  contributing are welcome to post questions here. The Git list requires
>>  plain-text-only emails and prefers inline and bottom-posting when replying to
>>  mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
>> -the list by sending an email to majordomo@vger.kernel.org with "subscribe git"
>> -in the body. The https://lore.kernel.org/git[archive] of this mailing list is
>> -available to view in a browser.
>> +the list by visiting https://subspace.kernel.org/vger.kernel.org.html and using
>> +the `sub` link next to the `git` list (this is a mailto link; you can leave
>> +subject and body blank, but you still have to send the email). The
>
> I recommend just telling people to send a message to
> git+subscribe@vger.kernel.org and linking to
> https://subspace.kernel.org/subscribing.html for more details. While
> "sub/unsub" links will do the job for some people, webmail users may not
> have things properly configured to correctly process the mailto: links.

Yeah, good suggestion.

Kyle, thanks for noticing the majordomo deprecation.

Perhaps something like this is agreeable to everybody?

------------ >8 ----------------------- >8 ----------------------- >8 ------------
Subject: Docs: majordomo@vger.kernel.org has been decomissioned

Update the instruction for subscribing to the Git mailing list
we have on a few documentation pages.

Noticed-by: Kyle Lippincott <spectral@google.com>
Helped-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/MyFirstContribution.txt | 5 +++--
 README.md                             | 4 ++--
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git c/Documentation/MyFirstContribution.txt w/Documentation/MyFirstContribution.txt
index 279f6a3e7c..f06563e981 100644
--- c/Documentation/MyFirstContribution.txt
+++ w/Documentation/MyFirstContribution.txt
@@ -35,8 +35,9 @@ announcements, design discussions, and more take place. Those interested in
 contributing are welcome to post questions here. The Git list requires
 plain-text-only emails and prefers inline and bottom-posting when replying to
 mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
-the list by sending an email to majordomo@vger.kernel.org with "subscribe git"
-in the body. The https://lore.kernel.org/git[archive] of this mailing list is
+the list by sending an email to <git+subscribe@vger.kernel.org>
+(see https://subspace.kernel.org/subscribing.html for details).
+The https://lore.kernel.org/git[archive] of this mailing list is
 available to view in a browser.
 
 ==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com]
diff --git c/README.md w/README.md
index 2c3de2f9c8..665ce5f5a8 100644
--- c/README.md
+++ w/README.md
@@ -39,8 +39,8 @@ Those wishing to help with error message, usage and informational message
 string translations (localization l10) should see [po/README.md][]
 (a `po` file is a Portable Object file that holds the translations).
 
-To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org (not the Git list). The mailing
+To subscribe to the list, send an email to <git+subscribe@vger.kernel.org>
+(see https://subspace.kernel.org/subscribing.html for details). The mailing
 list archives are available at <https://lore.kernel.org/git/>,
 <https://marc.info/?l=git> and other archival sites.
Kyle Lippincott Jan. 19, 2024, 10:46 p.m. UTC | #3
On Fri, Jan 19, 2024 at 2:26 PM Junio C Hamano <gitster@pobox.com> wrote:
> Subject: Docs: majordomo@vger.kernel.org has been decomissioned
>
> Update the instruction for subscribing to the Git mailing list
> we have on a few documentation pages.
>
> Noticed-by: Kyle Lippincott <spectral@google.com>
> Helped-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/MyFirstContribution.txt | 5 +++--
>  README.md                             | 4 ++--
>  2 files changed, 5 insertions(+), 4 deletions(-)

This version looks good, thanks for catching README.md's reference as well.
Kristoffer Haugsbakk Jan. 20, 2024, 10:48 a.m. UTC | #4
On Fri, Jan 19, 2024, at 23:26, Junio C Hamano wrote:
> Noticed-by: Kyle Lippincott <spectral@google.com>
> Helped-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Just curious. What’s the difference between `Reported-by` and
`Noticed-by`? `Reported-by` is documented in `SubmittingPatches` but not
the other one. Is perhaps `Reported-by` specifically meant for bug
reports?

Thanks
Junio C Hamano Jan. 20, 2024, 6:08 p.m. UTC | #5
"Kristoffer Haugsbakk" <code@khaugsbakk.name> writes:

> Just curious. What’s the difference between `Reported-by` and
> `Noticed-by`? `Reported-by` is documented in `SubmittingPatches` but not
> the other one. Is perhaps `Reported-by` specifically meant for bug
> reports?

It should be reported-by as the recent trend is to dedup similar
ones without much meaningful distinction and stick to those that are
listed in the document.  It was just me being careless and picked
one that used to be relatively common without even thinking:

 $ git rev-list --since 1.year --grep=Noticed-by: --count master
 2
 $ git rev-list --since 1.year --grep=Reported-by: --count master
 54

 $ git rev-list --since 5.year --until 4.year --grep=Noticed-by: --count master
 4
 $ git rev-list --since 5.year --until 4.year --grep=Reported-by: --count master
 102

 $ git rev-list --since 10.year --until 9.year --grep=Noticed-by: --count master
 12
 $ git rev-list --since 10.year --until 9.year --grep=Reported-by: --count master
 54

There probably is a subtle difference perceived between the two by
those who used noticed-by over the years and I think you guessed
their intention right.
diff mbox series

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 279f6a3e7ca..2361fe27e97 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -35,9 +35,11 @@  announcements, design discussions, and more take place. Those interested in
 contributing are welcome to post questions here. The Git list requires
 plain-text-only emails and prefers inline and bottom-posting when replying to
 mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
-the list by sending an email to majordomo@vger.kernel.org with "subscribe git"
-in the body. The https://lore.kernel.org/git[archive] of this mailing list is
-available to view in a browser.
+the list by visiting https://subspace.kernel.org/vger.kernel.org.html and using
+the `sub` link next to the `git` list (this is a mailto link; you can leave
+subject and body blank, but you still have to send the email). The
+https://lore.kernel.org/git[archive] of this mailing list is available to view
+in a browser.
 
 ==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com]