aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
...
* 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
* 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
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-27 00:47:45 +0000