aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
...
* committers-guide: minor improvements to the EnglishCeri Davies2023-04-061-3/+3
|
* Committer's Guide … Git … MFC … Examples: noneGraham Perrin2023-04-021-2/+0
| | | | | | | | | | | | | | The 'Examples' subheading that is currently at https://docs.freebsd.org/en/articles/committers-guide/#_examples has no subtext. Hiding the subheading was considered. Instead, it is deleted. https://bugs.freebsd.org/264080 PR: 264080 Approved by: imp Differential Revision: https://reviews.freebsd.org/D39384
* git-primer: Update how to rebase a vender branch mergeWarner Losh2023-03-311-36/+63
| | | | | | | | | | | | | | | Update the vendor branch merge section to include the missing commands and hopefully to make it more clear. Switch to using bogus branch names that will stand out on purpose. This rework 'play' tested on the lua branch merge, which needed dozens of rebasing... Also, indent by one space the conflict section so as to not confuse automated tools (or me) that it's a real conflict that needs to be resolved. Sponsored by: Netflix
* committers guide: remove "MFC with" tagEd Maste2023-03-212-9/+0
| | | | | | | | "Fixes" and "MFC with" are used for approximately the same purpose, but the former is standard in the Git-based deveopment world. Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D39190
* Committer guide: Correct the pacakge names of GCC12 for cross compilingLi-Wen Hsu2023-03-191-3/+3
| | | | | | | | Use the newly added syntax of the pacakge macro (in 1d899c1c6fc6). While here, fix some wording and typo spotted by Pau Amma. Differential Revision: https://reviews.freebsd.org/D39068
* Trademarks: Add Git, GitHub and GitLabLorenzo Salvadore2023-03-051-2/+2
| | | | | | | | | | | | | | | | | | | | | - Git: add the trademark line suggested by https://git-scm.com/about/trademark - GitLab: add the trademark line requested by https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/brand/brand-activation/trademark-guidelines/ - GitHub: it is a registered trademark according to the following links: https://github.com/logos https://docs.github.com/en/site-policy/github-terms/github-open-source-applications-terms-and-conditions#githubs-logos https://tmsearch.uspto.gov/bin/showfield?f=doc&state=4808:xvjz5y.2.4 Apply the newly introduced trademarks to the Committer's guide. Also add a TM symbol immediately after the first reference to the GitLab Name as requested by https://about.gitlab.com/handbook/marketing/brand-and-product-marketing/brand/brand-activation/trademark-guidelines/ Approved by: doceng (carlavilla) Differential Revision: https://reviews.freebsd.org/D38916
* committers-guide: spell checksCeri Davies2023-03-051-7/+7
|
* committers-guide: Add section on range of compilersWarner Losh2023-02-281-1/+61
| | | | | | | | | Document the range of compilers the project uses for building, CI and external toolchain support, and try to assign the proper level of effort developers should go to for each of them. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D38709
* git-primer: Trim old subversion infoWarner Losh2023-02-211-394/+4
| | | | | | | | It's been a couple of years since we transitioned to git. Remove this transition information. Should people really need it, it will be in the doc git repo history. Make minor tweaks to some adjacent material. Sponsored by: Netflix
* tiers: Remove obsolete languageWarner Losh2023-02-211-4/+0
| | | | | | | | amd64 is none of these things, so just remove the 'justifcation' sentence. It's wrong and fixing it wouldn't add any value. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D38708
* git primer: Fix two errorsWarner Losh2023-01-291-8/+1
| | | | | | | | | | | | | Recommend pushing HEAD:main in the vendor branch docs, since that's always going to be right. Stop recommending people set push.default to 'freebsd'. It's an enumerated value that's not a branch name. Most likely correct value here is 'upstream'. However, there's enough people with asymetrical setups that I'm just removing the setup rather than describe all the special cases. Sponsored by: Netflix
* git primer: Fix push commandWarner Losh2023-01-281-1/+1
| | | | | | | | | The instructions leave one on the merge_results branch, not on main, so pushing the remote repo won't work. You have to specifically add the branch name on the push for that to work. Noticed by: sjg Sponsored by: Netflix
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-01-211-604/+616
|
* Miscellaneous small changes to the Committer's Guide.Pau Amma2023-01-031-20/+28
| | | | | | | | | | | PR below plus a few more I spotted while working on it. While there, check nearby URLs still work and use https:. PR: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261812 Reviewed by: carlavlla, gjb, philip Approved by: carlavilla (mentor), gjb (mentor, earlier version) Differential Revision: https://reviews.freebsd.org/D37091
* license: Move to BSD-2-Clause and drop -FreeBSDWarner Losh2022-12-151-1/+1
| | | | | | | | | | | | | BSD-2-Clause-FreeBSD has been deprecated as a separate license. https://tools.spdx.org/app/check_license/ says that the text matches BSD-2-Cluase. There's some history behind the mismatch, but it's best to move forward now that our preferred license matches BSD-2-Clause. Sponsored by: Netflix Reviewed by: pauamma, andrew Differential Revision: https://reviews.freebsd.org/D37714
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-10-161-2/+36
|
* Add JetBrains to the committers perksMuhammad Moinur Rahman2022-10-091-10/+22
| | | | | | | | | | | JetBrains is offering 100 licenses yearly for FreeBSD committers. Add it to the Committer's Guide as perks. - Remove trailing whitespaces - Remove trailing blank lines PR: 264764 Approved by: carlavilla (mentor)
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-10-011-1019/+1024
|
* [doc-en][articles/committers-guide] Fix subsectionFernando Apesteguía2022-09-301-0/+1
| | | | | | Add a blank line after "====" subsection. The English version is rendered well anyway, but translations get the wrong string mixing the title and the content of the translation.
* doc: Add source .po files for translationsDanilo G. Baio2022-08-071-0/+9307
| | | | | | | | | | | | | | | | | | This helps the Weblate translation workflow and offline translations through .po files, it's important to update these files constantly. The goal here is to have a semi-automated translation workflow; Weblate will pull updates automatically from the main repository and commit translations to another repository. Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. $ ./tools/update_translate_template.sh documentation Anyway, I'll keep doing this periodically. Discussed with: doceng
* Fix typos in new account creation procedureSergio Carlavilla Delgado2022-06-261-1/+1
| | | | | PR: 264562 Submitted by: Graham Perrin <grahamperrin (AT) gmail.com>
* Upgrade PGP & GPG (No Starch Press) to correct linkSergio Carlavilla Delgado2022-06-241-1/+1
| | | | | PR: 264409 Submitted by: Graham Perrin <grahamperrin (AT) gmail.com>
* Update pkg_version reference to pkg version in comitters guidePau Amma2022-06-241-1/+1
| | | | | Approved by: carlavilla@, bapt@ Differential Revision: https://reviews.freebsd.org/D35273
* Spell Google correctly.Benedict Reuschling2022-06-051-1/+1
|
* articles/committers-guide: address verbiageJason Helfman2022-05-311-2/+2
| | | | Submitted by: pauamma@gundo.com
* articles/committers-guide: add Exim MTA instructions for smtp.freebsd.orgJason Helfman2022-05-251-0/+44
| | | | PR: 262742 (based on)
* committers-guide: fix the Phabricator wiki page addressGraham Perrin2022-05-211-1/+1
| | | | | | Reviewed by: dbaio, Pau Amma Pull Request: https://github.com/freebsd/freebsd-doc/pull/69 Differential Revision: https://reviews.freebsd.org/D35224
* Committers-guide port section: remove addportLuca Pizzamiglio2022-05-091-6/+19
| | | | | | | | | | | | | | | Summary: The script addport is not working anymore, it's based on SVN and it's quite hard to port it to git. Before its removal, we want to remove its references in the documentation. Related bugzilla entry: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261378 Reviewers: tcberner, se Differential Revision: https://reviews.freebsd.org/D35071
* Committer's guide: Fix about (re)moving portsLorenzo Salvadore2022-05-071-1/+1
| | | | | | | | | | | | Summary: - Move consideration about security vulnerabilities from instructions for removing ports to instructions for moving ports. - Reword the above consideration to take into account the splitting of vuln.xml into one file per year. Reviewed by: portmgr (rene), Pau Amma <pauamma@gundo.com> Approved by: docs (carlavilla), gerald (mentor) Differential Revision: https://reviews.freebsd.org/D35112
* Remove wollman@ from Who's who section of committer's guideSergio Carlavilla Delgado2022-05-031-4/+0
| | | | | | | Removed with the wollman@ approval PR: 261894 Submitted by: PauAmma <pauamma (AT) gundo.com>
* 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
|