[PATCH] doc: contributing.texi: document yhetil.org web service.

  • Open
  • quality assurance status badge
Details
4 participants
  • 45mg
  • Cayetano Santos
  • Ludovic Courtès
  • Simon Tournier
Owner
unassigned
Submitted by
Cayetano Santos
Severity
normal

Debbugs page

Cayetano Santos wrote 1 months ago
(address . guix-patches@gnu.org)(name . Cayetano Santos)(address . csantosb@inventati.org)
696290e50fcc308f606a59fc3c5b031e664aee44.1738927294.git.csantosb@inventati.org
Change-Id: I1a6a7283c9b25864447e0b0e396b72471db7ce74
Signed-off-by: Cayetano Santos <csantosb@inventati.org>
---
doc/contributing.texi | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)

Toggle diff (38 lines)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index c94ae940fa..2777f2279e 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -700,6 +700,29 @@ For more information, refer to @ref{Bug Reference,,, emacs, The GNU
Emacs Manual} and @ref{Minor Mode,,, debbugs-ug, The Debbugs User
Guide}.
+@node Tracking bugs and issues with public-inbox
+@subsection Tracking bugs and issues with public-inbox
+
+Contributing to Guix is strongly based on an email based workflow, as
+patches and bugs are sent by email to its corresponding
+maillists. Reviewers reply to emails, and an exchange thread follows
+until a consensus is reached, and the contribution is accepted or
+rejected. With time, this implies a deluge of emails on inboxes, which
+difficults collaboration of communities.
+
+As an alternative, the yhetil.org @url{https://yhetil.org} service,
+using Public Inbox @url{https://public-inbox.org/README.html}, provides
+an online, always available archive with the complete history of a
+maillist. It exposes a public, URL oriented fronted based on Message-ID
+identifiers to classify email exchanges. It offers full thread overview,
+atom feeds, reply links and thread download in mbox format for local
+maniputation.
+
+The yhetil.org service also includes advanced searching capabilities,
+which combined with mumi hints
+@url{https://issues.guix.gnu.org/help#search} to track status, tags,
+Message ID, etc., provides a powerful tool to contribute to Guix.
+
@node Alternative Setups
@section Alternative Setups

base-commit: 52c05f3b120e641c8bd2d68cfcf0d6af947de27b
--
2.48.1
Ludovic Courtès wrote 1 months ago
(name . Cayetano Santos)(address . csantosb@inventati.org)(address . 76119@debbugs.gnu.org)
87seoj7atl.fsf@gnu.org
Hi,

Cayetano Santos <csantosb@inventati.org> skribis:

Toggle quote (3 lines)
> +@node Tracking bugs and issues with public-inbox
> +@subsection Tracking bugs and issues with public-inbox

How about “Navigating Email with public-inbox”? Please also update the
menu above.

Toggle quote (4 lines)
> +Contributing to Guix is strongly based on an email based workflow, as
> +patches and bugs are sent by email to its corresponding
> +maillists. Reviewers reply to emails, and an exchange thread follows

I’d drop the second sentence and change the first one to something like:
“Contributing to Guix involves a lot of communication by email on public
mailing lists.” I think it’s enough.

Toggle quote (3 lines)
> +As an alternative, the yhetil.org @url{https://yhetil.org} service,
> +using Public Inbox @url{https://public-inbox.org/README.html}, provides

s/Public Inbox/public-inbox/ (apparently that’s how they spell it)

Also: @uref{https://public-inbox.org/README.html,public-inbox} rather
than a separate @url.

Could you send an updated patch?

Thanks,
Ludo’.
Cayetano Santos wrote 1 months ago
[PATCH v1] doc: contributing.texi: document yhetil.org web service.
(address . 76119@debbugs.gnu.org)(name . Cayetano Santos)(address . csantosb@inventati.org)
425b2e75b48aafd69aceea87c17dd5e55e619552.1739355419.git.csantosb@inventati.org
Change-Id: I1a6a7283c9b25864447e0b0e396b72471db7ce74
---
doc/contributing.texi | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)

Toggle diff (35 lines)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index c94ae940fa..4cf6148f3d 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -700,6 +700,28 @@ For more information, refer to @ref{Bug Reference,,, emacs, The GNU
Emacs Manual} and @ref{Minor Mode,,, debbugs-ug, The Debbugs User
Guide}.
+@node Navigating Email with public-inbox
+@subsection Navigating Email with public-inbox
+
+Contributing to Guix involves a lot of communication by email on public
+mailing lists. Reviewers reply to emails, and an exchange thread follows
+until a consensus is reached, and the contribution is accepted or
+rejected. With time, this implies a deluge of emails on inboxes, which
+difficults collaboration of communities.
+
+As an alternative, the yhetil.org @url{https://yhetil.org} service,
+using public-inbox @uref{https://public-inbox.org/README.html,
+public-inbox}, provides an online, always available archive with the
+complete history of a maillist. It exposes a public, URL oriented
+fronted based on Message-ID identifiers to classify email exchanges. It
+offers full thread overview, atom feeds, reply links and thread download
+in mbox format for local maniputation.
+
+The yhetil.org service also includes advanced searching capabilities,
+which combined with mumi hints
+@url{https://issues.guix.gnu.org/help#search} to track status, tags,
+Message ID, etc., provides a powerful tool to contribute to Guix.
+
@node Alternative Setups
@section Alternative Setups

base-commit: d59a13b6401e7494d8d5c9c9f66df3318451be79
--
2.48.1
45mg wrote 1 months ago
Re: [bug#76119] [PATCH] doc: contributing.texi: document yhetil.org web service.
(name . Cayetano Santos via Guix-patches via)(address . guix-patches@gnu.org)(address . 76119@debbugs.gnu.org)(name . Ludovic Court ès)(address . ludo@gnu.org)(name . Cayetano Santos)(address . csantosb@inventati.org)
87bjv7h2a3.fsf@gmail.com
Hi Cayetano,

Thanks for taking this up.

I just wanted to raise a question - what do we know about yhetil.org?
For example, do we know who maintains it? Are they committed to
maintaining it in the long term, or is this just a personal convenience
project that could disappear any moment?

I've used yhetil.org for a long time, but I still don't know these
things. I can't find any contact information on the home page, either.

Without that knowledge, it just feels a little odd for the Guix project
to officially trust and recommend the use of this particular online
service.

Like, imagine if the manual had a list of email providers that play nice
with GNU mailing lists. Sure, it would be useful information, but it
would also be seen as an endorsement of those providers; so we'd want to
look into their records on data privacy, etc first.

Obviously that level of concern is not warranted here since yhetil.org
is just a public-inbox archive; but I still think it would be good to
find out a bit more about that site.
Cayetano Santos wrote 1 months ago
(name . 45mg)(address . 45mg.writes@gmail.com)(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 76119@debbugs.gnu.org)(name . Cayetano Santos via Guix-patches via)(address . guix-patches@gnu.org)
87bjv7a06a.fsf@inventati.org
Toggle quote (27 lines)
>mer. 12 févr. 2025 at 10:43, 45mg <45mg.writes@gmail.com> wrote:

> Hi Cayetano,
>
> Thanks for taking this up.
>
> I just wanted to raise a question - what do we know about yhetil.org?
> For example, do we know who maintains it? Are they committed to
> maintaining it in the long term, or is this just a personal convenience
> project that could disappear any moment?
>
> I've used yhetil.org for a long time, but I still don't know these
> things. I can't find any contact information on the home page, either.
>
> Without that knowledge, it just feels a little odd for the Guix project
> to officially trust and recommend the use of this particular online
> service.
>
> Like, imagine if the manual had a list of email providers that play nice
> with GNU mailing lists. Sure, it would be useful information, but it
> would also be seen as an endorsement of those providers; so we'd want to
> look into their records on data privacy, etc first.
>
> Obviously that level of concern is not warranted here since yhetil.org
> is just a public-inbox archive; but I still think it would be good to
> find out a bit more about that site.

I have to say that I fully agree with you. Yhetil is one of the most
useful guix services from my perspective, but foreign to the
organisation, which is a risk. Kind of good to know, but no guarantees
whatsoever.

Let’s put this in stand-by. In the meantime, let’s try to know a bit
more about this yhetil ownership.

Thanks for your remarks,

--
Cayetano Santos
.
gpg: CCB8 1842 F9D7 058E CD67 377A BF5C DF4D F6BF 6682
key: meta.sr.ht/~csantosb.pgp
-----BEGIN PGP SIGNATURE-----

iI0EARYKADUWIQTMuBhC+dcFjs1nN3q/XN9N9r9mggUCZ6yBnRccY3NhbnRvc2JA
aW52ZW50YXRpLm9yZwAKCRC/XN9N9r9mgoLlAQCpS1fIt61Wd8nWSWdDdl9ThYVh
/3sG5mu48NSNc0tJSwEAsnNXFyWXAKP+Wa5NbXvvhBKQygNCve+WTAz1reWRnQg=
=HHmq
-----END PGP SIGNATURE-----

Cayetano Santos wrote 4 weeks ago
(address . guix-patches@gnu.org)(address . ludo@gnu.org)(address . 45mg.writes@gmail.com)(address . 76119@debbugs.gnu.org)(address . csantosb@inventati.org)
878qq1ylm6.fsf@inventati.org
We have now a hint on ownership of yhetil.org.


The service is stable since 2024 (5 years ago), we can put a name on it
(Kyle Meyer), and even if there are no guarantees whatsoever about how
long it will remain active (same as any other service), in my opinion we
may feel rather confident about its stability during a relevant period
of time, so as to include it as a useful reference in the documentation.

Additionally, the remarks Kyle states in its previous email about
cloning and mirroring seem fair to me.

--
Cayetano Santos
.
gpg: CCB8 1842 F9D7 058E CD67 377A BF5C DF4D F6BF 6682
key: meta.sr.ht/~csantosb.pgp
-----BEGIN PGP SIGNATURE-----

iI0EARYKADUWIQTMuBhC+dcFjs1nN3q/XN9N9r9mggUCZ7b/ERccY3NhbnRvc2JA
aW52ZW50YXRpLm9yZwAKCRC/XN9N9r9mglKTAQDELFBqkWsknq7/Oe1RPzszjkeJ
KYnNQsBZmQMC9cNqYQEAqDfm8s/nqkF6we8rqAdRwKr/pnKyOjMhvdEmZVT2lAo=
=q3cw
-----END PGP SIGNATURE-----

Simon Tournier wrote 4 weeks ago
(name . 45mg)(address . 45mg.writes@gmail.com)(address . 76119@debbugs.gnu.org)(name . Ludovic Courtès)(address . ludo@gnu.org)(name . Cayetano Santos)(address . csantosb@inventati.org)
87a5agell7.fsf@gmail.com
Hi,

On Wed, 12 Feb 2025 at 10:43, 45mg <45mg.writes@gmail.com> wrote:

Toggle quote (5 lines)
> I just wanted to raise a question - what do we know about yhetil.org?
> For example, do we know who maintains it? Are they committed to
> maintaining it in the long term, or is this just a personal convenience
> project that could disappear any moment?

Well, Kyle is around since years. :-)

We discussed many times to host such public-inbox instance under some
Guix umbrella. But hey Guix sysadmins have enough on their plates.

Maybe someone will take the ball rolling… :-)

Cheers,
simon

PS: Once you have Emacs-Notmuch, public-inbox and b4, it’s the perfect
setup, much better than any forge. ;-)
?
Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 76119@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 76119
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help