diff options
Diffstat (limited to 'documentation/content/en/books/fdp-primer')
5 files changed, 315 insertions, 114 deletions
diff --git a/documentation/content/en/books/fdp-primer/manual-pages/_index.po b/documentation/content/en/books/fdp-primer/manual-pages/_index.po index 60be8c8527..1f871f87f6 100644 --- a/documentation/content/en/books/fdp-primer/manual-pages/_index.po +++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-05-01 19:56-0300\n" +"POT-Creation-Date: 2025-08-17 20:54+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -1189,15 +1189,20 @@ msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:573 -msgid "man:groff_mdoc[7]" +msgid "man:style.mdoc[5]" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:574 +msgid "man:groff_mdoc[7]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:575 msgid "http://manpages.bsd.lv/mdoc.html[Practical UNIX Manuals: mdoc]" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:574 +#: documentation/content/en/books/fdp-primer/manual-pages/_index.adoc:575 msgid "http://manpages.bsd.lv/history.html[History of UNIX Manpages]" msgstr "" 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. diff --git a/documentation/content/en/books/fdp-primer/structure/_index.po b/documentation/content/en/books/fdp-primer/structure/_index.po index 9b4d092ce9..638848c070 100644 --- a/documentation/content/en/books/fdp-primer/structure/_index.po +++ b/documentation/content/en/books/fdp-primer/structure/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-05-01 19:56-0300\n" +"POT-Creation-Date: 2025-08-17 20:54+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -595,19 +595,54 @@ msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/structure/_index.adoc:267 #, no-wrap -msgid "Finding the Correct Files" +msgid "Mentor and New Committer Relationship Lists" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:271 msgid "" +"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." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:276 +msgid "" +"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." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:281 +msgid "" +"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." +msgstr "" + +#. type: Title === +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:282 +#, no-wrap +msgid "General Contributor Lists" +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:286 +msgid "" "extref:{contributors}[Contributors] to FreeBSD are maintained in article " "format. The source file for managing the *Contributors* article file is " "located at:" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:284 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:299 #, no-wrap msgid "" "doc\n" @@ -623,21 +658,21 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:287 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:302 msgid "" "Copies of this contributors directory may exist in other content language " "directories." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:290 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:305 msgid "" "Note that the file [.filename]#contrib-develinmemoriam.adoc# is also found " "in this directory. See below for additional information." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:295 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:310 msgid "" "The [.filename]#contributors/_index.adoc# file is designed as a collection " "of include files. The include files are listed in the Hugo specific section " @@ -647,7 +682,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:299 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:314 msgid "" "The text for each section of the *Contributors* page contains an \"include::" "\" statement. For example, the entry for \"Port Manager Alumni\" is " @@ -656,12 +691,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:301 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:316 msgid "To make a change, edit the appropriate include file:" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:310 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:325 #, no-wrap msgid "" "include-contrib-committers: [.filename]#~/doc/shared/contrib-committers.adoc#\n" @@ -673,7 +708,7 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:313 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:328 #, no-wrap msgid "" "Also, edit the [.filename]#authors.adoc# file: [.filename]#~/doc/shared/authors.adoc#\n" @@ -681,7 +716,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:319 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:334 msgid "" "In general, if a person is being added, there is only one edit necessary, " "and they can be added to the appropriate include file. If a person is being " @@ -691,273 +726,283 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:322 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:337 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:413 #, no-wrap msgid "Purpose" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:322 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:337 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:413 #, no-wrap msgid "Section Anchor" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:322 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:337 #, no-wrap msgid "File in ~/doc/shared/" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:323 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:348 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:338 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:414 #, no-wrap msgid "Order Specification" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:323 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:338 #, no-wrap msgid "*FreeBSD Developers*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:323 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:338 #, no-wrap msgid "include-contrib-committers" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:323 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:338 #, no-wrap msgid "[.filename]#contrib-committers.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:324 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:339 #, no-wrap msgid "alphabetical order by last name" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:324 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:339 #, no-wrap msgid "*Core Team Alumni*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:324 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:339 #, no-wrap msgid "include-contrib-corealumni" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:324 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:339 #, no-wrap msgid "[.filename]#contrib-corealumni.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:325 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:326 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:327 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:349 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:340 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:341 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:342 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:415 #, no-wrap msgid "rough reverse chronological order" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:325 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:340 #, no-wrap msgid "*Development Team Alumni*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:325 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:340 #, no-wrap msgid "include-contrib-develalumni" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:325 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:340 #, no-wrap msgid "[.filename]#contrib-develalumni.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:326 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:341 #, no-wrap msgid "*Ports Management Team Alumni*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:326 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:341 #, no-wrap msgid "include-contrib-portmgralumni" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:326 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:341 #, no-wrap msgid "[.filename]#contrib-portmgralumni.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:327 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:342 #, no-wrap msgid "*Additional FreeBSD Contributors*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:327 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:342 #, no-wrap msgid "include-contrib-additional" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:327 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:342 #, no-wrap msgid "[.filename]#contrib-additional.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:328 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:329 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:343 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:344 #, no-wrap msgid "alphabetical order by first name" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:328 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:343 #, no-wrap msgid "*386BSD Patch Kit Patch Contributors*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:328 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:343 #, no-wrap msgid "include-contrib-386bsd" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:328 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:343 #, no-wrap msgid "[.filename]#contrib-386bsd.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:329 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:344 #, no-wrap msgid "*Contributors to the central server project*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:329 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:330 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:331 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:332 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:344 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:345 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:346 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 #, no-wrap msgid "No include file used" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:329 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:330 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:331 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:332 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:344 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:345 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:346 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 #, no-wrap msgid "[.filename]#contributors/_index.adoc#" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:330 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:331 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:332 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:333 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:345 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:346 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:348 #, no-wrap msgid "unordered" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:330 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:345 #, no-wrap msgid "*Direct funding*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:331 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:346 #, no-wrap msgid "*Hardware contributors*" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:332 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 #, no-wrap msgid "*Special contributors*" msgstr "" #. type: Title === -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:335 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:350 #, no-wrap msgid "\"In Memoriam\" Section" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:338 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:353 msgid "" -"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:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:340 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:355 msgid "" -"Search the files above for the name, email address, and nickname (such as " -"`foobsd`)." +"Use the file [.filename]#~/doc/shared/authors.adoc# to look up the person's " +"name and attribute reference, such as `{foobsd}`." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:343 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:357 msgid "" -"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." +"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:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:344 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:359 msgid "" -"Where an email address is found with a name, remove the email address, but " -"leave the name." +"[.filename]#~/doc/shared/contrib-committers.adoc# - Remove the attribute " +"reference." msgstr "" -#. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:347 -#, no-wrap -msgid "File in ~/doc/documentation/content/{language}/articles/contributors/" +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:360 +msgid "" +"[.filename]#~/doc/shared/contrib-corealumni.adoc# - If they are a _current_ " +"member of the core team, create an entry showing start and end dates." msgstr "" -#. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:348 -#, no-wrap -msgid "*Development Team: In Memoriam*" +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:361 +msgid "" +"[.filename]#~/doc/shared/contrib-develalumni.adoc# - Add the attribute " +"reference and dates of activity as a committer." msgstr "" -#. type: Table -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:348 -#, no-wrap -msgid "[.filename]#contrib-develinmemoriam.adoc#" +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:362 +msgid "" +"[.filename]#~/doc/shared/contrib-portmgralumni.adoc# - Add the attribute " +"reference if necessary." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:353 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:363 +msgid "[.filename]#~/doc/shared/contrib-additional.adoc# - Remove the entry." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:365 +msgid "" +"[.filename]#~/doc/shared/contrib-386bsd.adoc# - This is a historical " +"document only. No changes are needed." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:368 msgid "" "In the [.filename]#~/doc/shared/authors.adoc# file, comment out (using one " "backslash '\\') the email address to avoid creating the email link \"mailto:" @@ -965,23 +1010,120 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:357 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:372 #, no-wrap msgid "[shared/authors.adoc]\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:359 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:365 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:374 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:380 #, no-wrap msgid "[..]\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/structure/_index.adoc:363 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:378 #, no-wrap msgid "" ":itojun-name: Jun-ichiro Itoh\n" ":itojun-email: \\itojun@FreeBSD.org\n" ":itojun: {itojun-name} <{itojun-email}>\n" msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:383 +msgid "" +"Since the member is deceased (which should be double checked), add them to " +"the \"In Memoriam\" file [.filename]#contrib-develinmemoriam.adoc#." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:386 +msgid "" +"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." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:388 +msgid "To find the date of their first commit, use:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:393 +#, no-wrap +msgid "" +"% cd ~/src\n" +"% git log --reverse --author=foobsd # search for first commit of foobsd\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:397 +msgid "" +"This will print out their commits in reverse order. The date of the first " +"commit will be at the top." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:399 +msgid "Ensure that the format of the dates match other entries:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:403 +#, no-wrap +msgid "(year of commit bit start - year of commit bit end; RIP year deceased)\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:405 +#, no-wrap +msgid "For example:\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:407 +#, no-wrap +msgid "* Foo BSD (2007 - 2010; RIP 2016)\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:410 +msgid "Check the ordering of the entries in the file." +msgstr "" + +#. type: Table +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:413 +#, no-wrap +msgid "File in ~/doc/documentation/content/{language}/articles/contributors/" +msgstr "" + +#. type: Table +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:414 +#, no-wrap +msgid "*Development Team: In Memoriam*" +msgstr "" + +#. type: Table +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:414 +#, no-wrap +msgid "[.filename]#contrib-develinmemoriam.adoc#" +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:418 +msgid "See the \"In Memoriam\" file for similar entries." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/structure/_index.adoc:420 +msgid "" +"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." +msgstr "" diff --git a/documentation/content/en/books/fdp-primer/translations/_index.adoc b/documentation/content/en/books/fdp-primer/translations/_index.adoc index 664ac9b216..7dbfa915c0 100644 --- a/documentation/content/en/books/fdp-primer/translations/_index.adoc +++ b/documentation/content/en/books/fdp-primer/translations/_index.adoc @@ -176,7 +176,7 @@ documentation/ `sv` is the name of the translation, in [.filename]#lang# form. Note the two Makefiles, which will be used to build the documentation. -Use git diff command to generate a diff and send it to the link:reviews.freebsd.org/[reviews system]. +Use git diff command to generate a diff and send it to the link:https://reviews.freebsd.org/[reviews system]. [source,shell] .... diff --git a/documentation/content/en/books/fdp-primer/translations/_index.po b/documentation/content/en/books/fdp-primer/translations/_index.po index 1b6dc2c847..6119798f80 100644 --- a/documentation/content/en/books/fdp-primer/translations/_index.po +++ b/documentation/content/en/books/fdp-primer/translations/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-05-01 19:56-0300\n" +"POT-Creation-Date: 2025-08-17 20:54+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -355,8 +355,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/translations/_index.adoc:180 msgid "" -"Use git diff command to generate a diff and send it to the " -"link:reviews.freebsd.org/[reviews system]." +"Use git diff command to generate a diff and send it to the link:https://" +"reviews.freebsd.org/[reviews system]." msgstr "" #. type: delimited block . 4 |