aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
...
* committers-guide: Fix typosLorenzo Salvadore2022-04-211-4/+4
| | | | | | | The correct syntax for git config --add does not want equality signs. Approved by: doc (lwhsu), gerald (mentor) Differential Revision: https://reviews.freebsd.org/D35017
* Remove duplicate content about blanket approval in committers guideSergio Carlavilla Delgado2022-03-261-8/+0
| | | | | Patch by: swills@ Differential Revision: https://reviews.freebsd.org/D31105
* Remove Google AnalyticsSergio Carlavilla Delgado2022-03-211-28/+4
| | | | | | | | | | | | Remove Google Analytics from the Website and from the Documentation Portal. Also upgrade the FreeBSD's privacy policy page to reflect the Google Analytics removal. In the near future it will be replace with an open source alternative Approved by: core@, webmaster@
* Change Port Management Team to Ports Management Team.Sergio Carlavilla Delgado2022-02-281-3/+3
| | | | | | | | Based on Ports Management Team charted the correct description of the Team is Ports Management Team PR: 261916 Submitted by: Graham Perrin <grahamperrin (AT) gmail.com>
* Move articles/contributors/contrib-* to the shared directoryDanilo G. Baio2021-11-041-4/+4
| | | | | | | | | | | | | | | These files can be used by all languages, except contrib-develinmemoriam.adoc. - contrib-386bsd.adoc - contrib-additional.adoc - contrib-committers.adoc - contrib-corealumni.adoc - contrib-develalumni.adoc - contrib-portmgralumni.adoc Reviewed by: bcr, carlavilla Differential Revision: https://reviews.freebsd.org/D32830
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-031-31/+31
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* git: recommend git bisect start --first-parentWarner Losh2021-10-111-2/+3
| | | | | | | | Due to how we do merge commits from the vendor branches, we don't want git bisect selecting those revisions as a bisection point. Recommend using 'git bisect start --first-parent' as a workaround. Sponsored by: Netflix
* committers-guide: Improve style of git commandsMateusz Piotrowski2021-10-071-2/+2
| | | | Add a space between the -m flag and its arguments.
* committers-guide: Mention MFH explicitlyMateusz Piotrowski2021-10-071-1/+1
| | | | | | | The process of merging ports commits from the main branch into a quarterly branch is called MFH (Merge From Head) for historical reasons. Mention MFH explicitly in the section describing the procedure so that it's easier to find it.
* committers-guide: Remove 'use-agent' from minimum gpg.conf settingsYasuhiro Kimura2021-09-291-1/+0
| | | | | | | | | | | | | | | In the gpg2(1) man page 'use-agent' option is explained as following. ---------------------------------------------------------------------- --use-agent --no-use-agent This is dummy option. gpg2 always requires the agent. ---------------------------------------------------------------------- It means adding 'use-agent' to gpg.conf is no-op. So remove it from minimum acceptable defaults of gpg.conf. Approved by: ygy (doc, mentor)
* committers-guide: use "Unsupported" instead of "Tier 4"Ed Maste2021-09-211-4/+4
| | | | | | | | | | | | Our use of "Tier 4" to represent unsupported architectures has caused confusion, especially when we did not explain what the tiers mean on in the platform list itself. Just use "Unsupported" to describe the architectures that are unsupported by a given release. Reviewed by: imp (earlier), ygy Approved by: ygy (mentor) Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D32030
* committers-guide: minor typos and one whitespace changeCeri Davies2021-08-161-2/+3
|
* committers-guide: Fix PGP keyring linkDanilo G. Baio2021-08-141-1/+1
|
* committers-guide: Register blanket approvals from docengDanilo G. Baio2021-08-081-0/+31
| | | | | Suggested by: lwhsu Approved by: doceng
* committers-guide: Place Differential Revision last in tableEd Maste2021-07-271-3/+3
| | | | | | | | | Differential Revision must be the last line of the commit message. List it last in the table as well to help make this clear. Reviewed by: imp, ygy Approved by: ygy Differential Revision: https://reviews.freebsd.org/D31309
* committers-guide: add missing periodEd Maste2021-07-261-1/+1
| | | | Approved by: ygy
* committers-guide: remove IRC cloak info for nowCeri Davies2021-07-221-7/+0
|
* committers-guide: various typo fixes and slightly clearer wordingCeri Davies2021-07-221-18/+18
|
* committers-guide: Fix col formatting error in last commitsKevin Bowling2021-07-151-1/+1
| | | | Pointy hat: me
* comitters-guide: Fix unterminated block in previous commitKevin Bowling2021-07-151-0/+1
|
* comitters-guide: clarify submitted and approved post gitKevin Bowling2021-07-151-9/+14
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D30969
* committers-guide: Document "Pull Request:" linesWarner Losh2021-06-301-0/+5
| | | | | | | | | A number of committers have started using "Pull Request:" to document when a change was submitted by a pull request to give context discussed there should it be necessary in the future. I documented it previously in the `Landing a github pull request` section by implication as well. Sponsored by: Netflix
* committers-guide: use a less sweary version of a git resource.Ceri Davies2021-06-251-1/+1
|
* committers-guide: fix typosWarner Losh2021-06-211-2/+2
| | | | | Noticed by: Pau Amma Sponsored by: Netflix
* committer-guide/git: Add what to do for pushing mainWarner Losh2021-06-201-1/+26
| | | | | | | | | | git arc stage lands commits on main. Some people think it's more natural to put changes on main and push that. Document how to do that as an alternative to the somewhat safer way of rebasing a branch and pushing that branch otno main. Also add tags to these sections so we (I?) can reference them easily when people ask. Sponsored by: Netflix
* Revert "Add Hugo's lang shortcode"Danilo G. Baio2021-06-191-9/+9
| | | | | | | This reverts commit 3462d12db6ebf303064db168a2333374344f369a. Too soon, it broke asciidoctor-pdf which doesn't know Hugo's shortcode. It will take more time and care.
* Add Hugo's lang shortcodeDanilo G. Baio2021-06-191-9/+9
| | | | | | | | | | | | | | | | | | This is a prerequisite for the translation workflow through .po files and Weblate. The asciidoctor include with the shortcode variable will help because won't be needed to change the includes manually after converting the translation (.po file) back to .adoc. It will help other areas like, language attributes, which today is fixed in every document. The use of shortcode was suggested by jmooring@ from Hugo's project on Github. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30823
* committers-guide: Strongly suggest careful review of all pull requestsWarner Losh2021-06-171-1/+7
| | | | | | | | | Pull requests should be treated with extreme caution and be carefully reviewed. Add this advice. Reviewed by: allanjude,bcr Sponsored by: Netflix Differential Revsion: https://reviews.freebsd.org/D30794
* committers-guide: Add note to check for default anonymous github namesWarner Losh2021-06-161-0/+11
| | | | | | | | | Github generates names like github-user <38923459+github-user@users.noreply.github.com> for it's web-created content. Add a note for people doing pull requests to check for this construct and to request a real name. Sponsored by: Netflix
* committer-guide: Add an anchor for the how to land a github pull request ↵Warner Losh2021-06-161-0/+1
| | | | | | | | section. So I can start dropping it into chats when people ask :) Sponsored by: Netflix
* committers-guide: git always requires a clean tree to rebase.Warner Losh2021-06-161-1/+1
| | | | | | Remove confusing word. Sponsored by: Netflix
* committers-guide: fix thinko: this should be --ff-only to match elsewhereWarner Losh2021-06-161-1/+1
|
* committers-guide: wordsmith the basics with the links a little.Warner Losh2021-06-151-4/+3
| | | | Sponsored by: Netflix
* comitter-guide: Add link to git for computer scientistsWarner Losh2021-06-151-0/+1
| | | | | | | | Add a link that I've shared with several people who found it useful to get a good mental model of git. It's written specifically for computer scientists. Sponsored by: Netflix
* committer-guide: Add link to migration articleWarner Losh2021-06-141-0/+1
| | | | | | | | Although the final commit in the old, legacy repo had excellent details on migration, this article has a few details that might also be helpful in migrating. Add it as an additional resource. Sponsored by: Netflix
* Improve English terms.Ceri Davies2021-06-131-1/+1
|
* Move the developer-centric bits from handbook/mirrors to committers-guideWarner Losh2021-06-111-1/+100
| | | | | | | | | The developer centric bits of how to interact with the project belong in the committer's guide, not in the handbook, so move it there. Reviewed by: gjb,debdrup Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D30739
* articles/committers-guide: remove 'work in progres' noteJason Helfman2021-06-091-5/+0
| | | | Reviewed by: imp@
* Remove an extra space after '+' charactersDanilo G. Baio2021-06-081-45/+45
| | | | | | | | | | | | | This is happening only on documentation/, basically in all places that attaches a block or a paragraph to a list [1]. Although this is working, it impacts our translation tool po4a, the '+' character is a difficult part when processing asciidoc[tor] files. 1 - https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30688
* committers-guide: pull request landing tweaks.Warner Losh2021-06-031-2/+2
| | | | | | | | | | | Clarify that only closing the pull request resuires a GitHub account. All the other steps can proceed without one. Also, include --push-option=confirm-author in the push because pull requests will have a different author than the committer and this instructs the src pre-commit hooks to allow the commit through. Sponsored by: Netflix
* git: document how to merge a pull request from github.Warner Losh2021-06-031-0/+54
| | | | | | Reviewed by: ceri@, ygy@ Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D30589
* Add a more obvious link to ref*/universe* machinesPhilip Paeps2021-05-241-0/+3
| | | | PR: 256109
* Replace references to svnadmin branchFernando Apesteguía2021-05-211-16/+3
| | | | | | | | In committers-guide, handbook and the new-account page in the website. There were references to the old `svnadmin` branch. Approved by: 0mp (mentor) Differential Revision: https://reviews.freebsd.org/D29922
* en/articles/*: Set includes paths according to the backend used for theMarc Fonvieille2021-05-191-0/+16
| | | | | build. This fixes the PDF versions.
* committers-guide: Correct some paths for consistencyGuangyuan Yang2021-05-171-4/+4
|
* Update instructions on adding new committer entries.Ceri Davies2021-05-141-3/+2
| | | | Approved by: blackend (mentor)
* phb: Change instructions for new ports.Mathieu Arnold2021-05-101-10/+16
|
* Point people to git-grep's man page directly.Mathieu Arnold2021-05-101-2/+2
| | | | | As we are talking about the tool and not an exact command to use, it feels more helpfull to give a link to the man page.
* Tell people how to use cp(1) to copy a port.Mathieu Arnold2021-05-101-0/+11
|
* committers-guide: Improve hyphenations and branch namesGuangyuan Yang2021-05-071-5/+5
| | | | Submitted by: gnn