aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
...
* committers-guide: Update Gandi benefitsMateusz Piotrowski2021-05-061-2/+3
| | | | | | | Apart from some cosmetic changes, let's add a note that filling in the billing information first really speeds up the process. Reported by: Cédric Leroy <cedric.leroy@gandi.net>
* Improve SEO with the keywors meta tagSergio Carlavilla Delgado2021-05-041-0/+1
| | | | | | Add in all articles and books the tag list. Modify the theme to use the tag list defined in articles and books to generate the keywords meta tag
* Improve descriptions for some books and articlesAllan Jude2021-05-021-1/+2
| | | | | | | | | | Also add weights to some, to define the sort order in the index Put the more commonly used items at the top of their respective lists The improved descriptions were taken from the old books/articles list: https://www.freebsd.org/docs/books/ Sponsored-By: Klara Inc.
* Improve the SEO of the documentation portalSergio Carlavilla Delgado2021-05-011-1/+1
| | | | | | | Changes: - Add the description meta tag in the index, articles and books - Add a brief description in each article and book. - Remove the SVN expansion tag
* Fix minor typo: s/Exteral/External/.Dimitry Andric2021-04-281-1/+1
|
* Add a first quick and dirty draft of what Git can do with GnuPG.Mathieu Arnold2021-04-271-0/+50
| | | | | Reviewed by: rene, imp, lwhsu Differential Revision: https://reviews.freebsd.org/D29726
* Add a short section about commit message for ports.Mathieu Arnold2021-04-271-0/+27
| | | | | Reviewed by: bapt Differential Revision: https://reviews.freebsd.org/D29994
* committers-guide: Remove confusing lineMateusz Piotrowski2021-04-261-1/+0
| | | | It is unclear what this line is referring to. Remove it.
* committers-guide: Do not use google as a verbMateusz Piotrowski2021-04-261-1/+1
|
* committers-guide: Merge duplicate policies into oneMateusz Piotrowski2021-04-261-1/+1
| | | | Those two points describe the same situation. Merge them into one point.
* committers-guide: Update list of files all committers may modifyMateusz Piotrowski2021-04-261-1/+1
| | | | The paths have changed after the switch to Git.
* committers-guide: Clean up commit bit types descriptionMateusz Piotrowski2021-04-261-1/+1
| | | | | | There is no need to mention explicitly that src committers may commit to the doc tree if they receive an appropriate approval. That's true for all the other committer types and trees.
* articles/committers-guide: fix typoCeri Davies2021-04-261-1/+1
|
* committer-guide: master->main rename in an example or twoWarner Losh2021-04-261-3/+3
| | | | | | | These instances of master or freebsd/master which should really be main. I did these examples against the old github mirror. Sponsored by: Netflix
* [committers-guide] Remove obsolete misc questionFernando Apesteguía2021-04-221-7/+0
| | | | | | | Adding files in Git does not requiere special considerations. Approved by: 0mp Differential Revision: https://reviews.freebsd.org/D29884
* [committers-guide] Fix typoFernando Apesteguía2021-04-221-1/+1
| | | | | | | s/relese/release Approved by: 0mp Differential Revision: https://reviews.freebsd.org/D29889
* [committers-guide] Consistent use of SubversionFernando Apesteguía2021-04-221-6/+6
| | | | | | | Majority of the uses capitalize the first letter. Let the rest do the same. Approved by: 0mp Differential Revision: https://reviews.freebsd.org/D29888
* [committers-guide] Update src branches informationFernando Apesteguía2021-04-211-2/+2
| | | | | | | | | | | | | | | Summary: s/SVN/Git s/head/main Although there are other branches in the repo (like vendor/ or releng/), if they were not considered noteworthy before, I choose not make them notheworthy now. Test Plan: * Renders OK. Reviewers: 0mp, gbe Differential Revision: https://reviews.freebsd.org/D29886
* committers-guide: Fix indentation of commit message examplesMateusz Piotrowski2021-04-201-10/+10
|
* committers-guide: Remove "Submitted by" from examplesMateusz Piotrowski2021-04-201-3/+4
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D29868
* committers-guide: Discourage use of Submitted byMateusz Piotrowski2021-04-201-2/+2
| | | | The use of "Submitted by" is discouraged in all the source trees now.
* committers-guide: Bring back MFH metadata fieldMateusz Piotrowski2021-04-201-0/+3
| | | | | | | | | The MFH field is still useful to note that the commit is going to be merged into a quarterly branch. Reported by: mat Reviewed by: mat Differential Revision: https://reviews.freebsd.org/D29862
* articles/committers-guide: Document change in MFH policyMateusz Piotrowski2021-04-201-59/+1
| | | | | | | | Merging commits into the quarterly branch no longer requires an explicit approval [1]. Let's remove outdated documentation and leave a note explaining that there is no need for an explicit approval to MFH. [1] https://svnweb.freebsd.org/ports?view=revision&revision=556626
* articles/committers-guide: Update "MFC with" descriptionMateusz Piotrowski2021-04-201-1/+1
| | | | We use Git hashes now, not revision numbers.
* Clarify that the vendor merge commits should have proper commit messagesMark Johnston2021-04-191-0/+1
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D29745
* articles/committers-guide: fix README linkFernando Apesteguía2021-04-181-1/+1
| | | | | | | | | | Current link in Committer's Guide for the README of the addkeys.sh script is broken. It should point to https://docs.freebsd.org/pgpkeys/README. Approved by: 0mp (mentor) Differential Revision: https://reviews.freebsd.org/D28928
* [Committers Guide] Fix paths in Steps for New CommittersFernando Apesteguía2021-04-181-2/+2
| | | | | | | | | | | | * There is no authors.toml but authors.adoc * Add `doc` in the path as in the other steps to make explicit that we refer to the `doc` repository. * s/shared/share in `src` repository: Approved by: 0mp (mentor) Differential Revision: https://reviews.freebsd.org/D28590
* Provide a one-liner for the "Fixes" commit key wordMateusz Piotrowski2021-04-171-1/+1
|
* Capitalize words properlyMateusz Piotrowski2021-04-171-44/+44
| | | | | | I've capitalized "git" throughout the document where appropriate. There are also some other words I've fixed like "github" and "gitlab", but I've not reviewed the whole document looking for those.
* Correct the cgit repository URL for ports tree.Ryusuke SUZUKI2021-04-171-1/+1
|
* Do not recommend filling "Fixes:" with SVN revisionsMateusz Piotrowski2021-04-161-2/+1
| | | | The ports tree has transitioned to Git already.
* Add rsync.net percs in FreeBSD Committer's GuideMuhammad Moinur Rahman2021-04-121-0/+7
|
* Fix a typo and some word tagging.Marc Fonvieille2021-04-111-5/+5
|
* Add missing whitespace and correct tagging to one command.Marc Fonvieille2021-04-111-1/+1
|
* [committers-guide] Add missing wordFernando Apesteguía2021-04-101-1/+1
| | | | | | | In section 5.8 Collaborating with others. Approved by: gbe Differential Revision: https://reviews.freebsd.org/D29693
* Rough draft on collaboration using githubGeorge V. Neville-Neil2021-04-091-1/+7
|
* Address points brought up by bsdimpGeorge V. Neville-Neil2021-04-091-10/+10
|
* Add langauge and other simple updates from uqsGeorge V. Neville-Neil2021-04-091-22/+20
|
* Rough draft on collaboration using githubGeorge V. Neville-Neil2021-04-091-0/+87
|
* Add OpenSMTPD example for sending mail through FreeBSD mxsMuhammad Moinur Rahman2021-04-061-0/+24
| | | | | | | | Adds an example on howto configure OpenSMPTD to forward locally sent mails to FreeBSD.org mail servers. Approved by: crees, imp Differential Revision: https://reviews.freebsd.org/D29574
* Remove the subversion section from the committer's guide.Warner Losh2021-04-061-842/+6
| | | | | | | | | FreeBSD committers no longer need to know how to use subversion. Remove the subversion primer from the committer's guide. Add a VCS history section. Suggestions by: lwhsu@ Differential Revision: https://reviews.freebsd.org/D29610
* Committers Guide: fix some URLs and mention our GitHub mirror.Rene Ladan2021-04-061-2/+3
| | | | Submitted by: lwhsu
* Committers Guide: update the ports-specific sections to git.Rene Ladan2021-04-061-213/+26
| | | | | | | | | | | | | | - Remove notes that the migration is in progress - Remove old branch names and URLs - Remove mention of psvn - Remove section about re-adding a deleted port, git add will do the right thingn natively (most of the times). - Remove section about repo-copies, git has no copy command. - Simplify instructions for moving a port. - Remove section about the mfh tool. Merges are now just cherry-picks. Reviewed by: crees, emaste, imp, lwhsu, mat Differential Revision: https://reviews.freebsd.org/D29450
* Upgrade committers-guide and freebsd-releng with the new doc tech.Sergio Carlavilla Delgado2021-03-201-1/+1
| | | | | Upgrade committers-guide and freebsd-releng to show the new documentation tech - Hugo/AsciiDoctor
* Minor word smithingWarner Losh2021-03-191-6/+7
| | | | | | Fix a few typoes, grammar errors, wrong word choices, and a bad url. Submitted by: Pau Amma
* Fix typos, style and fix AsciiDoc syntax in bsdl-gpl, building products and ↵Sergio Carlavilla Delgado2021-03-191-559/+867
| | | | | | | | | | committers guide bsdl-gpl: style line building products: style line and fix images path committers-guide: style line, convert some MarkDown links to Asciidoc and upgrade some entries still making reference to the old Docbook tech.
* spdx: document usageWarner Losh2021-03-191-0/+14
| | | | | | | | | Document that we try to follow SPDX 2.2 for the SPDX-License-Idneitfier: tags that are in the source. Note that they are informative only. Give pointers to the standards and a status of the files marked in-tree. Suggestions by: Pau Amma Differential Revision: https://reviews.freebsd.org/D29330
* Lots of improvements.Warner Losh2021-03-191-63/+53
| | | | | | | Lots of wording improvements, grammar errors, punctuation error and wrong word fixes. Also, do some limited one sentence one line (1s1l) conversion. Submitted by: Pau Amma (though not the 1s1l stuff).
* git: add FAQWarner Losh2021-03-181-0/+410
| | | | | | Add in the FAQ from the github docs I did for the transition. Submissions from: rpokala@, jrm@, Marc Branchaud and "mirror176".
* MFC: tweak the langaugeWarner Losh2021-03-181-2/+1
| | | | | | | Don't say there are two options and then give only one. Update that sentence to reflect where the project seems to have landed in terms of how to do MFCs. The original was written prior to the transtion and the existing practice has shifted to cherry-pick -x almost exclusively.