Commit graph

15 commits

Author SHA1 Message Date
Ed Maste
ef7b781366 committers-guide: update commit trailer descriptions
- Add `Reported by`, `Tested by`, `Fixes`, `MFH`.
- Mention that `Submitted by` is typically not used with git.
- Add more cases to `Approved by`.
- Move `Sponsored by:` to the same place it appears in the template.

Reviewed by:	debdrup
Approved by:	debdrup
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D28905
2021-02-24 14:02:53 -05:00
Ceri Davies
a0f7ad455b Multiple files: Fix 'shared' references
The hier(7) man-page lists /usr/share as the location for
architecture-independent files, so fix a few instances where the
documentation referes to /usr/shared instead of /usr/share.

PR:		253760
2021-02-22 19:29:41 +01:00
Ed Maste
b2a9be92ae committers-guide: add missing line break in commit message section
Fixes: 11f8235774 ("Add commit message information to committer's guide")
2021-02-20 14:09:20 -05:00
Ed Maste
11f8235774 Add commit message information to committer's guide
Provide some guidance on good git commit messages.  Based on an article
I wrote, with further editing and feedback by imp in the temporary git
docs repo.

Reviewed by:	debdrup, imp
Approved by:	debdrup
Differential Revision:	https://reviews.freebsd.org/D28815
2021-02-20 13:44:21 -05:00
Marc Fonvieille
cb2679f843 Typ: s/upto-date/up-to-date 2021-02-18 18:44:54 +01:00
Rajesh Kumar M A
1c5c36df2d Documentation repo changes to add new committer Rajesh Kumar M A
Approved by: vmaffione, gallatin

Differential Revision: https://reviews.freebsd.org/D28587
2021-02-17 06:24:38 +00:00
Sergio Carlavilla Delgado
e7ea1aea59 Incorrect $FreeBSD$ expansion in Building Products articles
PR:         253554
Patch by:   ceri (AT) submonkey.net
2021-02-16 22:48:12 +01:00
Nuno Eduardo Simões Leal Teixeira
17eef34c77 Steps 1-4 from the Committer's guide (eduardo) 2021-02-07 14:18:04 +00:00
Warner Losh
b3f6ba6ff5 Start to update the committer's guide with git information
Do the easy git updates for URLs and branch names. Note svn guide
is just for ports (but don't edit out the src specific bits
since we'll dump it wholesale in 2 months). Add pointer to my
draft docs until they can all be integrated.
2021-02-04 10:36:16 -07:00
Warner Losh
32f3af824f Remove old, draft version of git primer.
This contains a very early version of the git primer that's incomplete. It's
also unreferenced in the tree. Remove it.
2021-02-03 15:15:08 -07:00
Sergio Carlavilla Delgado
57930f3fd5 Upgrade pgpkeys related tools and committers guide new committer section 2021-02-01 22:23:03 +01:00
Glen Barber
790a769f67 releng: fix rendering of replaceable variables
Add 'subs="attributes"' to [source] and [.programlisting] blocks
to properly replace variables in rendered output.

Sponsored by:	Rubicon Communications, LLC ("Netgate")
2021-02-01 16:15:09 -05:00
Sergio Carlavilla Delgado
d8d889ea90 MFH info missing from Committers Guide
Restore MFH info in the committers guide.

PR:             253065
Submitted by:   fernanpe@
2021-01-30 20:36:26 +01:00
Lewis Cook
2d42c615e6 Add committer entries for Lewis Cook <lcook>
Approved by: 		fernape (mentor)
Differential Revision: 	https://reviews.freebsd.org/D28275
2021-01-26 16:06:28 +00:00
Sergio Carlavilla Delgado
989d921f5d Migrate doc to Hugo/AsciiDoctor
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
2021-01-26 00:31:29 +01:00