989d921f5d
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
115 lines
3.3 KiB
Text
115 lines
3.3 KiB
Text
---
|
|
title: FreeBSD Documentation Project Primer for New Contributors
|
|
authors:
|
|
- author: The FreeBSD Documentation Project
|
|
copyright: 1998-2021 DocEng
|
|
releaseinfo: "$FreeBSD$"
|
|
trademarks: ["general"]
|
|
---
|
|
|
|
= FreeBSD Documentation Project Primer for New Contributors
|
|
:doctype: book
|
|
:toc: macro
|
|
:toclevels: 2
|
|
:icons: font
|
|
:xrefstyle: basic
|
|
:relfileprefix: ../
|
|
:outfilesuffix:
|
|
:sectnums:
|
|
:sectnumlevels: 6
|
|
:partnums:
|
|
:chapter-signifier: Chapter
|
|
:part-signifier: Part
|
|
:source-highlighter: rouge
|
|
:experimental:
|
|
:skip-front-matter:
|
|
:book: true
|
|
:pdf: false
|
|
|
|
ifeval::["{backend}" == "html5"]
|
|
include::shared/mirrors.adoc[]
|
|
include::shared/authors.adoc[]
|
|
include::shared/releases.adoc[]
|
|
include::shared/en/mailing-lists.adoc[]
|
|
include::shared/en/teams.adoc[]
|
|
include::shared/en/urls.adoc[]
|
|
:chapters-path: content/en/books/fdp-primer/
|
|
endif::[]
|
|
|
|
ifeval::["{backend}" == "pdf"]
|
|
include::../../../../shared/mirrors.adoc[]
|
|
include::../../../../shared/authors.adoc[]
|
|
include::../../../../shared/releases.adoc[]
|
|
include::../../../../shared/en/mailing-lists.adoc[]
|
|
include::../../../../shared/en/teams.adoc[]
|
|
include::../../../../shared/en/urls.adoc[]
|
|
:chapters-path:
|
|
endif::[]
|
|
|
|
ifeval::["{backend}" == "epub3"]
|
|
include::../../../../shared/mirrors.adoc[]
|
|
include::../../../../shared/authors.adoc[]
|
|
include::../../../../shared/releases.adoc[]
|
|
include::../../../../shared/en/mailing-lists.adoc[]
|
|
include::../../../../shared/en/teams.adoc[]
|
|
include::../../../../shared/en/urls.adoc[]
|
|
:chapters-path:
|
|
endif::[]
|
|
|
|
[.abstract-title]
|
|
[abstract]
|
|
Abstract
|
|
|
|
Thank you for becoming a part of the FreeBSD Documentation Project. Your contribution is extremely valuable, and we appreciate it.
|
|
|
|
This primer covers details needed to start contributing to the FreeBSD Documentation Project, or FDP, including tools, software, and the philosophy behind the Documentation Project.
|
|
|
|
This is a work in progress. Corrections and additions are always welcome.
|
|
|
|
'''
|
|
|
|
toc::[]
|
|
|
|
include::{chapters-path}toc-figures.adoc[]
|
|
|
|
include::{chapters-path}toc-tables.adoc[]
|
|
|
|
include::{chapters-path}toc-examples.adoc[]
|
|
|
|
:sectnums!:
|
|
|
|
include::{chapters-path}preface/chapter.adoc[leveloffset=+1, lines=7..-1]
|
|
|
|
:sectnums:
|
|
|
|
include::{chapters-path}overview/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}tools/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}working-copy/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}structure/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}doc-build/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}asciidoctor-primer/chapter.adoc[leveloffset=+1, lines=7..21; 27..-1]
|
|
|
|
include::{chapters-path}rosetta/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}translations/chapter.adoc[leveloffset=+1, lines=7..21; 28..-1]
|
|
|
|
include::{chapters-path}po-translations/chapter.adoc[leveloffset=+1, lines=7..21; 27..-1]
|
|
|
|
include::{chapters-path}manual-pages/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}writing-style/chapter.adoc[leveloffset=+1, lines=7..21; 27..-1]
|
|
|
|
include::{chapters-path}editor-config/chapter.adoc[leveloffset=+1, lines=7..21; 25..-1]
|
|
|
|
include::{chapters-path}see-also/chapter.adoc[leveloffset=+1, lines=7..21; 27..-1]
|
|
|
|
:sectnums!:
|
|
|
|
include::{chapters-path}examples/chapter.adoc[leveloffset=+1, lines=6..21; 25..-1]
|
|
|
|
:sectnums:
|