Path: blob/main/documentation/content/en/books/fdp-primer/structure/_index.po
18098 views
# SOME DESCRIPTIVE TITLE # Copyright (C) YEAR The FreeBSD Project # This file is distributed under the same license as the FreeBSD Documentation package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\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 <[email protected]>\n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. type: YAML Front Matter: description #: documentation/content/en/books/fdp-primer/structure/_index.adoc:1 #, no-wrap msgid "Documentation Directory Structure explanation used in the FreeBSD Documentation Project" msgstr "" #. type: YAML Front Matter: title #: documentation/content/en/books/fdp-primer/structure/_index.adoc:1 #, no-wrap msgid "Chapter 4. Documentation Directory Structure" msgstr "" #. type: Title = #: documentation/content/en/books/fdp-primer/structure/_index.adoc:14 #, no-wrap msgid "Documentation Directory Structure" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:52 msgid "Files and directories in the *doc/* tree follow a structure meant to:" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:54 msgid "Make it easy to automate converting the document to other formats." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:55 msgid "" "Promote consistency between the different documentation organizations, to " "make it easier to switch between working on different documents." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:56 msgid "" "Make it easy to decide where in the tree new documentation should be placed." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:59 msgid "" "In addition, the documentation tree must accommodate documents in many " "different languages. It is important that the documentation tree structure " "does not enforce any particular defaults or cultural preferences." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:61 #, no-wrap msgid "The Top Level, doc/" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:64 msgid "" "There are three sections under *doc/*, documentation and website share the " "same structure." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:68 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:97 #, no-wrap msgid "Directory" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:70 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:100 #, no-wrap msgid "Usage" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:71 #, no-wrap msgid "*documentation*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:74 #, no-wrap msgid "" "Contains all the articles and books in AsciiDoc format.\n" "Contains subdirectories to further categorize the information by languages." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:75 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:128 #, no-wrap msgid "*tools*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:78 #, no-wrap msgid "" "Contains a set of tools used to translate the documentation and the website using link:https://weblate.org/en/[Weblate].\n" "The Weblate instance can be found link:https://translate-dev.freebsd.org[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:79 #, no-wrap msgid "*shared*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:83 #, no-wrap msgid "" "Contains files that are not specific to the various translations of the documentation.\n" "Contains subdirectories to further categorize the information by languages and three files to store the authors, releases and mirrors information.\n" "This directory is shared between `documentation` and the `website`." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:84 #, no-wrap msgid "*website*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:86 #, no-wrap msgid "" "Contains the link:https://www.FreeBSD.org[FreeBSD website] in AsciiDoc format.\n" "Contains subdirectories to further categorize the information by languages." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:89 #, no-wrap msgid "The Directories" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:93 msgid "" "These directories contain the documentation and the website. The " "documentation is organized into subdirectories below this level, following " "the link:https://gohugo.io/getting-started/directory-structure/[Hugo " "directory structure]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:101 #, no-wrap msgid "*archetypes*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:104 #, no-wrap msgid "" "Contain templates to create new articles, books and webpages.\n" "For more information take a look link:https://gohugo.io/content-management/archetypes/[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:105 #, no-wrap msgid "*config*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:109 #, no-wrap msgid "" "Contain the Hugo configuration files.\n" "One main file and one file per language.\n" "For more information take a look link:https://gohugo.io/getting-started/configuration/[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:110 #, no-wrap msgid "*content*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:113 #, no-wrap msgid "" "Contain the books, articles and webpages.\n" "One directory exists for each available translation of the documentation, for example `en` and `zh-tw`." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:114 #, no-wrap msgid "*data*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:118 #, no-wrap msgid "" "Contain custom data for build the website in link:https://en.wikipedia.org/wiki/TOML[TOML] format.\n" "This directory is used to store the events, news, press, etc.\n" "For more information take a look link:https://gohugo.io/templates/data-templates/[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:119 #, no-wrap msgid "*static*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:123 #, no-wrap msgid "" "Contain static assets.\n" "Images, security advisories, the pgpkeys, etc.\n" "For more information take a look link:https://gohugo.io/content-management/static-files/[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:124 #, no-wrap msgid "*themes*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:127 #, no-wrap msgid "" "Contain the templates in the form of `.html` files that specify how the website looks.\n" "For more information take a look link:https://gohugo.io/templates/[here]." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:131 #, no-wrap msgid "" "Contain tools used to enhance the documentation build.\n" "For example to generate the Table of Contents of the books, etc." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:132 #, no-wrap msgid "*beastie.png*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:134 #, no-wrap msgid "This image does not need an introduction ;)" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:135 #, no-wrap msgid "*LICENSE*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:137 #, no-wrap msgid "License of the documentation, shared and website. BSD 2-Clause License." msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:138 #, no-wrap msgid "*Makefile*" msgstr "" #. type: Table #: documentation/content/en/books/fdp-primer/structure/_index.adoc:139 #, no-wrap msgid "The *Makefile* defines the build process of the documentation and the website." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:142 #, no-wrap msgid "Document-Specific Information" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:145 msgid "" "This section contains specific notes about particular documents managed by " "the FDP." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:147 #, no-wrap msgid "The Books: books/" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:150 msgid "The books are written in AsciiDoc." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:153 msgid "" "For each FreeBSD book, the AsciiDoc document type (aka doctype) is `book`. " "Books have ``part``s, each of which contains several ``chapter``s." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:155 msgid "" "When the document is converted to HTML 5 (using the built-in `html5` " "backend):" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:157 msgid "" "AsciiDoc section level 0 (`=`) at the beginning of a ``chapter`` of a `book` " "will be `<h1>`" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:158 msgid "" "AsciiDoc section level 1 (`==`) must be used for the first logical section " "of a chapter, and will be `<h2>`" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:159 msgid "" "AsciiDoc section level 2 (`===`) must be used for the first logical " "subsection, and will be `<h3>`" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:161 msgid "" "– and so on. Reference: link:https://docs.asciidoctor.org/asciidoc/latest/" "sections/titles-and-levels/[Section Titles and Levels | Asciidoctor Docs]." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/structure/_index.adoc:163 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:223 #, no-wrap msgid "Physical Organization" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:166 msgid "" "There are a number of files and directories within the books directory, all " "with the same structure." msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/structure/_index.adoc:168 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:228 #, no-wrap msgid "_index.adoc" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:171 msgid "" "The *_index.adoc* file defines some AsciiDoc variables that affect how the " "AsciiDoc source is converted to other formats and list the Table of " "Contents, Table of Examples, Table of Figures, Table of Tables and the " "abstract section." msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/structure/_index.adoc:173 #, no-wrap msgid "book.adoc" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:177 msgid "" "The *book.adoc* file defines some AsciiDoc variables that affect how the " "AsciiDoc source is converted to other formats and list the Table of " "Contents, Table of Examples, Table of Figures, Table of Tables, the abstract " "section and all the chapters. This file is used to generate the PDF with " "`asciidoctor-pdf` and to generate the book in one `html` page." msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/structure/_index.adoc:179 #, no-wrap msgid "part*.adoc" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:181 msgid "" "The **part*.adoc** files store a brief introduction of one part of the book." msgstr "" #. type: Title ==== #: documentation/content/en/books/fdp-primer/structure/_index.adoc:183 #, no-wrap msgid "directory/_index.adoc" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:186 msgid "" "Each chapter in the Handbook is stored in a file called *_index.adoc* in a " "separate directory from the other chapters." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:188 msgid "For example, this is an example of the header of one chapter:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:191 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:236 #, no-wrap msgid "---\n" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:196 #, no-wrap msgid "" "title: Chapter 8. Configuring the FreeBSD Kernel\n" "part: Part II. Common Tasks\n" "prev: books/handbook/multimedia\n" "next: books/handbook/printing\n" "---\n" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:199 msgid "[[kernelconfig]]" msgstr "" #. type: Title = #: documentation/content/en/books/fdp-primer/structure/_index.adoc:199 #, no-wrap msgid "Configuring the FreeBSD Kernel" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:201 msgid "..." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:204 msgid "" "When the HTML5 version of the Handbook is produced, this will yield " "*kernelconfig/index.html*." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:206 msgid "" "A brief look will show that there are many directories with individual " "*_index.adoc* files, including *basics/_index.adoc*, *introduction/" "_index.adoc*, and *printing/_index.adoc*." msgstr "" #. type: delimited block = 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:212 msgid "" "Do not name chapters or directories after their ordering within the " "Handbook. This ordering can change as the content within the Handbook is " "reorganized. Reorganization should be possible without renaming files, " "unless entire chapters are being promoted or demoted within the hierarchy." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:215 #, no-wrap msgid "The Articles: articles/" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:218 msgid "The articles are written in AsciiDoc." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:221 msgid "" "The articles are organized as an AsciiDoc `article`. The articles are " "divided into sections (`=`) and subsections (`==`, `===`) and so on." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:226 msgid "There is one *_index.adoc* file per article." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:231 msgid "" "The *_index.adoc* file contains all the AsciiDoc variables and the content." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:233 msgid "" "For example, this is an example of one article, the structure is pretty " "similar to one book chapter:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:242 #, no-wrap msgid "" "title: Why you should use a BSD style license for your Open Source Project\n" "authors:\n" " - author: Bruce Montague\n" " email: [email protected]\n" "trademarks: [\"freebsd\", \"intel\", \"general\"]\n" "---\n" msgstr "" #. type: Title = #: documentation/content/en/books/fdp-primer/structure/_index.adoc:244 #, no-wrap msgid "Why you should use a BSD style license for your Open Source Project" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:253 msgid "" ":doctype: article :toc: macro :toclevels: 1 :icons: " "font :sectnums: :sectnumlevels: 6 :source-highlighter: rouge :experimental:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:255 msgid "'''" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:257 msgid "toc::[]" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/structure/_index.adoc:259 msgid "[[intro]]" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:259 #, no-wrap msgid "Introduction" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/structure/_index.adoc:262 #, no-wrap msgid "Managing Contributor Lists" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/structure/_index.adoc:266 msgid "" "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." msgstr "" #. type: Title === #: documentation/content/en/books/fdp-primer/structure/_index.adoc:267 #, no-wrap 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:299 #, no-wrap msgid "" "doc\n" " /documentation\n" " /content\n" " /{language}\n" " /articles\n" " /contributors\n" " [.filename]#_index.adoc# – Contains a list of include files that apply to each section.\n" " [.filename]#_index.po# – Translation page\n" " [.filename]#contrib-develinmemoriam.adoc# - content of “In Memoriam” section\n" " [.filename]#contrib-develinmemoriam.po# – Translation page\n" msgstr "" #. type: Plain text #: 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: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: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 " "of the source file. The section is divided into several parts with \"ifdef::" "\" statements. There is a sub-section for website output and one for non-" "website (including PDF) output." msgstr "" #. type: Plain text #: 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 " "`include::{include-contrib-portmgralumni}[]`. This pulls in the text for " "port manager alumni into the rendered output." msgstr "" #. type: Plain text #: 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:325 #, no-wrap msgid "" "include-contrib-committers: [.filename]#~/doc/shared/contrib-committers.adoc#\n" "include-contrib-corealumni: [.filename]#~/doc/shared/contrib-corealumni.adoc#\n" "include-contrib-develalumni: [.filename]#~/doc/shared/contrib-develalumni.adoc#\n" "include-contrib-portmgralumni: [.filename]#~/doc/shared/contrib-portmgralumni.adoc#\n" "include-contrib-additional: [.filename]#~/doc/shared/contrib-additional.adoc#\n" "include-contrib-386bsd: [.filename]#~/doc/shared/contrib-386bsd.adoc#\n" msgstr "" #. type: delimited block - 4 #: 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" "and any related translations.\n" msgstr "" #. type: Plain text #: 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 " "moved from \"current\" to \"alumni\" status, two edits are required - one to " "remove and one to insert for the appropriate files. The order of entries " "for all files is found in the table below." msgstr "" #. type: Table #: 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: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:337 #, no-wrap msgid "File in ~/doc/shared/" msgstr "" #. type: Table #: 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:338 #, no-wrap msgid "*FreeBSD Developers*" msgstr "" #. type: Table #: 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:338 #, no-wrap msgid "[.filename]#contrib-committers.adoc#" msgstr "" #. type: Table #: 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:339 #, no-wrap msgid "*Core Team Alumni*" msgstr "" #. type: Table #: 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:339 #, no-wrap msgid "[.filename]#contrib-corealumni.adoc#" msgstr "" #. type: Table #: 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:340 #, no-wrap msgid "*Development Team Alumni*" msgstr "" #. type: Table #: 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:340 #, no-wrap msgid "[.filename]#contrib-develalumni.adoc#" msgstr "" #. type: Table #: 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:341 #, no-wrap msgid "include-contrib-portmgralumni" msgstr "" #. type: Table #: 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:342 #, no-wrap msgid "*Additional FreeBSD Contributors*" msgstr "" #. type: Table #: 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:342 #, no-wrap msgid "[.filename]#contrib-additional.adoc#" msgstr "" #. type: Table #: 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:343 #, no-wrap msgid "*386BSD Patch Kit Patch Contributors*" msgstr "" #. type: Table #: 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:343 #, no-wrap msgid "[.filename]#contrib-386bsd.adoc#" msgstr "" #. type: Table #: 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: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: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: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:345 #, no-wrap msgid "*Direct funding*" msgstr "" #. type: Table #: 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:347 #, no-wrap msgid "*Special contributors*" msgstr "" #. type: Title === #: 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:353 msgid "" "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:355 msgid "" "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:357 msgid "" "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:359 msgid "" "[.filename]#~/doc/shared/contrib-committers.adoc# - Remove the attribute " "reference." msgstr "" #. 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: 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: 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: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:" "\" See the example for `itojun` below:" msgstr "" #. type: delimited block . 4 #: 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: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:378 #, no-wrap msgid "" ":itojun-name: Jun-ichiro Itoh\n" ":itojun-email: \\[email protected]\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 ""