Commit graph

14 commits

Author SHA1 Message Date
Warner Losh
86836673be Fix more typos from the original github docs
Fix a number of typos. Note why one would prefer publishing a repo over
phabricator. Try to minimize use of contractions. Clarify the mysterious 'source
of truth' phrase.

Noticed by: Pau Amma (except the contractions)
2021-03-16 18:43:35 -06:00
Warner Losh
371c80a880 git: Move vendor branch stuff to the new git-primer section of committer guide
Vendor branch managed belongs in the comitter guide, as it is relevant to
comitters and not to the larger community of people developing for FreeBSD,
which the developer's guide more genereal development.
2021-03-16 15:30:54 -06:00
Warner Losh
a2fbd7a750 Remove svn vendor import information.
It is no longer relevant to the day-to-day operations of the project. It's all
done with git now. We have the old content in the doc repo should someone need
this information in the future.
2021-03-16 14:43:40 -06:00
Warner Losh
35c2ff4910 Remove sparc64 trademark
We don't reference sparc64 in either of these chapters, so remove it from the
trademark list.
2021-03-16 14:31:54 -06:00
Li-Wen Hsu
b6c72f65a8
Fix weird generated format
Approved by:	carlavilla (implicitly)
2021-03-16 19:10:07 +08:00
Li-Wen Hsu
a9a9e66105
Use correct syntax markup for shell
Approved by:	carlavilla
2021-03-14 20:08:55 +08:00
Ed Maste
3707c59faf committers-guide: update example to match guidance
We suggest capitalizing the first letter of the title line, so do so in
an example.

Reported by:	jhb
2021-02-25 18:57:12 -05:00
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
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
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
Sergio Carlavilla Delgado
57930f3fd5 Upgrade pgpkeys related tools and committers guide new committer section 2021-02-01 22:23:03 +01: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
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