aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles
Commit message (Collapse)AuthorAgeFilesLines
...
* Improve text in several waysWarner Losh2021-03-171-34/+37
| | | | | | | Fix typos, improve wording, remove redundantly repetitive words, fix punctuation and grammer errors. Submitted by: Pau Amma
* committer handbook: Fix typos and reformatWarner Losh2021-03-171-70/+50
| | | | | | | | Fix a few typos and reformat a few paragraphs to one line per sentence style. Try to use repository insteast of 'repo' or even 'source of truth'. Clarify a few places and fix some grammar errors. Submitted by: Pau Amma
* Fix typo in committers guideBenjamin Kaduk2021-03-171-1/+1
|
* xxx: remove xxxWarner Losh2021-03-171-4/+2
| | | | Remove a couple of links that I didn't go back and fix before committing.
* Update vendor import with suggestionsWarner Losh2021-03-171-16/+17
| | | | | | | | | Add git commit --amend with a comment about doing a final check of the commit message before the push. Update with some more specific guidance on a good commit message. Add link to commit message section. Minor tweaks I noticed while doing this as well for having one setence one line. Submitted by cy@
* Add the git miniprimerWarner Losh2021-03-171-0/+424
| | | | | | | | Add in the git minirpimer from my github. It contains the basics that you'll need to track the tree and/or contribute. Contributions by: rwatson@, Rainer Hurling, jhb@, Ceri Davies, lwhsu@, chuck@, Robert Gogolok
* Committer's Guide: list the new commits mailing lists to replace svn onesLi-Wen Hsu2021-03-171-1/+1
| | | | Approved by: carlavilla (implicitly)
* Document what Signed-off-by meansWarner Losh2021-03-171-0/+4
| | | | | We get submissions with this from time to time, so document what signed-off-by means. It's not used extensively in FreeBSD at this time.
* Merge in the migration from subversion / githubWarner Losh2021-03-171-7/+268
| | | | | | | Add in the migrating from the old subversion / git docs. This section should be removed in a few months maybe. Contributions by: lwshu@, Alexander Richardson, kib@, Ceri Davies
* Alternative formatting on freebsd/developer/* blocksKa Ho Ng2021-03-171-2/+2
| | | | | | | | | | Use angle brackets instead of italic to denote mandatory fields after "freebsd/developer/" blocks. "freefall name" and "NickServ name" are also renamed to "freefall username"` and "FreeNode account". Reviewed by: debdrup, ygy, lwhsu Approved by: philip (mentor) Differential Revision: https://reviews.freebsd.org/D29285
* Move the MFC doc from my freebsd-git-docs repo to handbookWarner Losh2021-03-171-0/+494
| | | | | | | | Integreate MFC procedures into the committer's handbook. This was originally in my freebsd-git-docs repo where it was collaberatively created. The changes here are light edits and a conversion from markdown to asciidoc. Contributions from: jhb@, lwhsu@, delphij@, Ceri Davies, Alexandre
* Two more typos I made while fixing the last typos.Warner Losh2021-03-171-2/+2
| | | | Noticed by: Pau Amma
* Fix more typos from the original github docsWarner Losh2021-03-171-31/+29
| | | | | | | | 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)
* git: Move vendor branch stuff to the new git-primer section of committer guideWarner Losh2021-03-161-0/+228
| | | | | | 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.
* Remove svn vendor import information.Warner Losh2021-03-161-210/+0
| | | | | | 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.
* Remove sparc64 trademarkWarner Losh2021-03-162-2/+2
| | | | | We don't reference sparc64 in either of these chapters, so remove it from the trademark list.
* Fix weird generated formatLi-Wen Hsu2021-03-161-1/+2
| | | | Approved by: carlavilla (implicitly)
* Add committer entries for Ka Ho Ng <khng>Ka Ho Ng2021-03-162-0/+4
| | | | | | | | | | Steps 1-4 from the Committer's guide: * Add entries for Ka Ho Ng <khng> * Add PGP key Reviewed by: philip Approved by: philip (mentor) Differential Revision: https://reviews.freebsd.org/D29282
* Use correct syntax markup for shellLi-Wen Hsu2021-03-1424-262/+262
| | | | Approved by: carlavilla
* committers-guide: update example to match guidanceEd Maste2021-02-251-1/+1
| | | | | | | We suggest capitalizing the first letter of the title line, so do so in an example. Reported by: jhb
* committers-guide: update commit trailer descriptionsEd Maste2021-02-241-5/+28
| | | | | | | | | | | | - 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
* Multiple files: Fix 'shared' referencesCeri Davies2021-02-222-7/+7
| | | | | | | | 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
* committers-guide: add missing line break in commit message sectionEd Maste2021-02-201-1/+2
| | | | Fixes: 11f82357745e ("Add commit message information to committer's guide")
* Add commit message information to committer's guideEd Maste2021-02-201-0/+148
| | | | | | | | | | 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
* Typ: s/upto-date/up-to-dateMarc Fonvieille2021-02-181-1/+1
|
* Documentation repo changes to add new committer Rajesh Kumar M ARajesh Kumar M A2021-02-171-0/+1
| | | | | | Approved by: vmaffione, gallatin Differential Revision: https://reviews.freebsd.org/D28587
* Incorrect $FreeBSD$ expansion in Building Products articlesSergio Carlavilla Delgado2021-02-161-1/+1
| | | | | PR: 253554 Patch by: ceri (AT) submonkey.net
* Steps 1-4 from the Committer's guide (eduardo)Nuno Eduardo Simões Leal Teixeira2021-02-073-1/+4
|
* Start to update the committer's guide with git informationWarner Losh2021-02-041-22/+26
| | | | | | | 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.
* Remove old, draft version of git primer.Warner Losh2021-02-031-590/+0
| | | | | This contains a very early version of the git primer that's incomplete. It's also unreferenced in the tree. Remove it.
* Upgrade pgpkeys related tools and committers guide new committer sectionSergio Carlavilla Delgado2021-02-011-11/+9
|
* releng: fix rendering of replaceable variablesGlen Barber2021-02-011-13/+13
| | | | | | | Add 'subs="attributes"' to [source] and [.programlisting] blocks to properly replace variables in rendered output. Sponsored by: Rubicon Communications, LLC ("Netgate")
* MFH info missing from Committers GuideSergio Carlavilla Delgado2021-01-301-3/+411
| | | | | | | Restore MFH info in the committers guide. PR: 253065 Submitted by: fernanpe@
* Add committer entries for Lewis Cook <lcook>Lewis Cook2021-01-263-1/+4
| | | | | Approved by: fernape (mentor) Differential Revision: https://reviews.freebsd.org/D28275
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-2544-0/+20860
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