From nobody Wed Aug 13 07:05:19 2025 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4c1zsX0Rx3z648m4 for ; Wed, 13 Aug 2025 07:05:20 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4c1zsW6lZxz3VwV; Wed, 13 Aug 2025 07:05:19 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1755068719; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ghZCYxdAacnI1QQSPvuUOEQNowZ1tN1pmzCN19gfsko=; b=mnqAbisPp/VfIHu3hSIZXrqmJbT/ioEOTjsb536/X5Cs5ZUSMGzG4ezRc6V/rDCQfOsp+E +ZG2MqVMUFpQ4R37CW6S0xTJv6JeAqJxCt7juiRX4jdj8fj39YxmzIxU11Mz8hB3KCFEvm 37zcvYkbIdcTiIJQIctLOelQaYhqhJ7IDF5amezq7pMgDMgjmleGhBb/cvl2H+mGwH0z4Q D4OWrxpBwWDK120sR6RjiZ7qMiKW14kNqrj9fMlswGapaMIuCm7blwLf9sXyTxwkgcDxld /FqCtr0Yhmkv2lM0PNN1PU++qlgAANKw5tj1j0LCkGDILgLhbR2qFakOoxw+rA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1755068719; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=ghZCYxdAacnI1QQSPvuUOEQNowZ1tN1pmzCN19gfsko=; b=sSDBNXxzkrMAfMPmrfEMhROboDsWeGnb/MqapJwnuh8T9X+zeo6YuDC1uQ1j9/aTDVZIXM clCRnQ6zFlEl/YsqVW9DWpzFsIMr/bnGwcekEN0AbzcSb0u7XDG7lofyBmq1AJNuvDVoJU QXeZLqImjbchm4luUSf4SzV6Ayi4MAiKIUBtL1qw/ybunrsaa00srCOEURXcNAxLok/JEp K2ltmvTk94LVuiHO75P0JKQl1gCsQpH0TTLFCgF5eBSIOYV0wKR369BIlEczeXt2EBg3Bf VlRxO1J+sy8HNSRGVeFxPqKTQSOEsEg0ko/E86cTQoF1/ZX3xIVtzcT1b6TC1g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1755068719; a=rsa-sha256; cv=none; b=A1ydiTySuiq8cNFNduSiEtCTPYDBi0PrSARrlvxOl2DAQtxz+HOGMq39yrUGOBhgJm26iH 4JdeTfpThLo7dwc7pS3BJ7Ocu6WaUH0th+iiUbAwat2K9uR3trrDtzAI7xoGYquhi77GVB YPUX3o29D4RDBnn/YKV5yjclRoo7A1XlbmvsWFtL3xBVF6PTYCAOKPBrE/Ksh0SOFQhLyr Ni35zo+zqIz0f3hJ0/+nMypFT26jZ/6ZLCAbgWmyxGuIap7u9ENIZk/NpFvfADOM055XiU tWEM1HtJnTVLWn7c+j9XGWVXaMDsbDroDqSl6tHAfJq47hmOgRIj5XwpBFDdiQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4c1zsW5z8cz1C4S; Wed, 13 Aug 2025 07:05:19 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 57D75J5l049081; Wed, 13 Aug 2025 07:05:19 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 57D75Jmw049078; Wed, 13 Aug 2025 07:05:19 GMT (envelope-from git) Date: Wed, 13 Aug 2025 07:05:19 GMT Message-Id: <202508130705.57D75Jmw049078@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 1fbfb510ad - main - FDP - Structure: Updated Managing Contributor Lists List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 1fbfb510add163573dbed2d522f91c415380a76e Auto-Submitted: auto-generated The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=1fbfb510add163573dbed2d522f91c415380a76e commit 1fbfb510add163573dbed2d522f91c415380a76e Author: Jim Brown AuthorDate: 2025-08-13 07:03:51 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2025-08-13 07:03:51 +0000 FDP - Structure: Updated Managing Contributor Lists Reviewed by: ziaee@ Approved by: dbaio@, carlavilla@ Differential Revision: D49225 --- .../en/books/fdp-primer/structure/_index.adoc | 78 ++++++++++++++++++---- 1 file changed, 66 insertions(+), 12 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc index 864ad53d7e..6aa5e17776 100644 --- a/documentation/content/en/books/fdp-primer/structure/_index.adoc +++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc @@ -264,7 +264,22 @@ toc::[] The FreeBSD project recognizes contributors in several different lists in the documentation and in printed materials. This section describes how the documentation team manages changes to these lists. -=== Finding the Correct Files +=== Mentor and New Committer Relationship Lists + +Since FreeBSD 7.0, FreeBSD has maintained link:https://cgit.freebsd.org/src/tree/share/misc[three lists of contributor mentor / mentee relationships] - one for source code, one for ports and one for documentation. +These files are in *".dot"* format, intended for use with the popular graphing toolkit package:graphics/graphviz[] available as a FreeBSD package or port. + +[NOTE] +==== +man:dot[1] is installed as part of the package:graphics/graphviz[] package or port. +The [.filename]#dot# program reads files in *".dot"* format and creates a graphical image of the directed graph. +==== + +The three files often serve as a learning experience for new committers of all three teams who are instructed to add themselves, and their mentor, to the appropriate file as their first commit. +Each file has a "current" section for new committers, an "alumni" section for when the commit bit is returned, and a "mentor / mentee" section showing the relationships. +The format for each type of entry is explained at the top of the file. + +=== General Contributor Lists extref:{contributors}[Contributors] to FreeBSD are maintained in article format. The source file for managing the *Contributors* article file is located at: @@ -334,19 +349,19 @@ The order of entries for all files is found in the table below. === "In Memoriam" Section -If the intent is to notify the BSD community of the death of a community member, the following procedures should be used: +When notifying the BSD community of the death of a community member, the following procedure should be used: -. Search the files above for the name, email address, and nickname (such as `foobsd`). -. Since the member is deceased (which should be double checked) remove the name from the appropriate file and add them to the "In Memoriam" file ([.filename]#contrib-develinmemoriam.adoc# as noted above) by editing the appropriate files. -Try to find some additional information about their contributions to FreeBSD over the years and add it with their entry in the file. -This may require asking in the development mailing lists, contacting colleagues, contacting the FreeBSD Foundation, or searching through the commit logs. -. Where an email address is found with a name, remove the email address, but leave the name. +. Use the file [.filename]#~/doc/shared/authors.adoc# to look up the person's name and attribute reference, such as `{foobsd}`. +. If they are a current member of one or more FreeBSD project teams in [.filename]#~/doc/website/content/en/administration.adoc#, remove all instances of their attribute reference. +Also, complete the following edits: + -[cols="25%,25%,25%,25%", frame="none", options="header"] -|=== -| Purpose | Section Anchor | File in ~/doc/documentation/content/{language}/articles/contributors/ | Order Specification -| *Development Team: In Memoriam* | [.filename]#contrib-develinmemoriam.adoc# | [.filename]#contrib-develinmemoriam.adoc# | rough reverse chronological order -|=== +* [.filename]#~/doc/shared/contrib-committers.adoc# - Remove the attribute reference. +* [.filename]#~/doc/shared/contrib-corealumni.adoc# - If they are a _current_ member of the core team, create an entry showing start and end dates. +* [.filename]#~/doc/shared/contrib-develalumni.adoc# - Add the attribute reference and dates of activity as a committer. +* [.filename]#~/doc/shared/contrib-portmgralumni.adoc# - Add the attribute reference if necessary. +* [.filename]#~/doc/shared/contrib-additional.adoc# - Remove the entry. +* [.filename]#~/doc/shared/contrib-386bsd.adoc# - This is a historical document only. +No changes are needed. + . In the [.filename]#~/doc/shared/authors.adoc# file, comment out (using one backslash '\') the email address to avoid creating the email link "mailto:" See the example for `itojun` below: @@ -363,4 +378,43 @@ See the example for `itojun` below: [..] .... ++ +. Since the member is deceased (which should be double checked), add them to the "In Memoriam" file [.filename]#contrib-develinmemoriam.adoc#. ++ +Try to find some factual information about their contributions to FreeBSD over the years and add it with their entry in the file. +This may require asking in the development mailing lists, contacting colleagues, contacting the FreeBSD Foundation, or searching through the commit logs. ++ +To find the date of their first commit, use: ++ +[source.programlisting,asciidoc] +.... +% cd ~/src +% git log --reverse --author=foobsd # search for first commit of foobsd +.... ++ +This will print out their commits in reverse order. +The date of the first commit will be at the top. ++ +Ensure that the format of the dates match other entries: ++ +[source.programlisting,asciidoc] +.... +(year of commit bit start - year of commit bit end; RIP year deceased) +For example: + +* Foo BSD (2007 - 2010; RIP 2016) +.... ++ +Check the ordering of the entries in the file. ++ +[cols="25%,25%,25%,25%", frame="none", options="header"] +|=== +| Purpose | Section Anchor | File in ~/doc/documentation/content/{language}/articles/contributors/ | Order Specification +| *Development Team: In Memoriam* | [.filename]#contrib-develinmemoriam.adoc# | [.filename]#contrib-develinmemoriam.adoc# | rough reverse chronological order +|=== ++ +See the "In Memoriam" file for similar entries. ++ +. Finally, if applicable, move the committer member entry from the "current" section to the "alumni" section of the appropriate link:https://cgit.freebsd.org/src/tree/share/misc[list of contributor mentor / mentee relationships] along with an appropriate date. +It is not necessary to change the mentor / mentee relationship.