Commit Graph

275 Commits

Author SHA1 Message Date
Sergio Carlavilla Delgado 0d9894b11e Improve the SEO of the documentation portal
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
2021-05-02 00:54:35 +02:00
Oskar Holmlund e633f0b9df Add committers entries for Oskar Holmlund (oh)
Step 7.1.[1-4] in committers guide.

Reviewed by: manu, br, delphij
Approved by: manu (mentor)
Differential Revision: https://reviews.freebsd.org/D29996
2021-04-30 14:12:09 +02:00
Lewis Cook cc7b0877fb books/porters-handbook: Include fish-shell completion path
Approved by:		0mp, ygy
Differential Revision:	https://reviews.freebsd.org/D29973
2021-04-29 15:20:46 +01:00
Dimitry Andric 14874cd74d Fix minor typo: s/Exteral/External/. 2021-04-28 20:29:18 +02:00
Marc Fonvieille 8c4d527185 en/books/developers-handbook: Fix imagesdir path to allow images embedding in PDF 2021-04-28 18:28:24 +02:00
Marc Fonvieille a1aad57d6d en/books/developers-handbook/sockets/: Fix figures caption. 2021-04-28 18:01:27 +02:00
Ryusuke SUZUKI cb6fa9060a 132ff9d795 -> 5dddbce327 2021-04-28 20:55:48 +09:00
Marc Fonvieille 1fbaec46fa en/books/handbook/wine/_index.adoc: Fix wrong markup for a Web link. 2021-04-28 12:14:28 +02:00
Marc Fonvieille 3254c49c84 /en/books/handbook/wine/: remove extra whitespaces in some command lines. 2021-04-28 11:39:31 +02:00
Marc Fonvieille 2f4bcd81ab en/books/handbook/wine: add a missing .png extension which prevented the
image rendering.
2021-04-28 11:33:21 +02:00
Ryusuke SUZUKI fe72008903 989d921f5d -> f847aaeb60 2021-04-28 01:39:23 +09:00
Ryusuke SUZUKI f847aaeb60 o Remove 12.1-RELEASE from the Handbook index page. 2021-04-27 22:32:23 +09:00
Mathieu Arnold a6e878928c
Add a first quick and dirty draft of what Git can do with GnuPG.
Reviewed by:	rene, imp, lwhsu
Differential Revision:	https://reviews.freebsd.org/D29726
2021-04-27 08:16:49 +02:00
Mathieu Arnold fb18f59114
Add a short section about commit message for ports.
Reviewed by:	bapt
Differential Revision:	https://reviews.freebsd.org/D29994
2021-04-27 08:14:40 +02:00
Andreas Bjørnestad 1114f5f2d2 handbook: fix typo
PR:	252706
2021-04-26 20:42:55 -04:00
Allan Jude 43cb53c0e1 Fix missing markup that was messing up the first paragraph
Sponsored-by:	Klara Inc.
2021-04-26 20:28:43 -04:00
Mateusz Piotrowski 18298aec36 committers-guide: Remove confusing line
It is unclear what this line is referring to. Remove it.
2021-04-26 22:46:09 +02:00
Mateusz Piotrowski 6e8e66005b committers-guide: Do not use google as a verb 2021-04-26 22:40:03 +02:00
Mateusz Piotrowski 77e05e5b5c committers-guide: Merge duplicate policies into one
Those two points describe the same situation. Merge them into one point.
2021-04-26 22:36:33 +02:00
Mateusz Piotrowski 70d4e0e799 committers-guide: Update list of files all committers may modify
The paths have changed after the switch to Git.
2021-04-26 22:34:26 +02:00
Mateusz Piotrowski 656d6eccb7 committers-guide: Clean up commit bit types description
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.
2021-04-26 22:34:26 +02:00
Ceri Davies cdc25df8de articles/committers-guide: fix typo 2021-04-26 14:18:49 -04:00
Warner Losh b9c2beb17b committer-guide: master->main rename in an example or two
These instances of master or freebsd/master which should really be
main. I did these examples against the old github mirror.

Sponsored by:		Netflix
2021-04-26 10:20:16 -06:00
Warner Losh bcf75b25de kobj: Use one sentence per line
In advance of updating this chapter, go through and make it one sentence
per line. No content changes.

Sponsored by:		Netflix
2021-04-26 10:20:16 -06:00
Ryusuke SUZUKI 8889d10710 7859bada69 -> 6269a3efb8 2021-04-26 20:03:13 +09:00
Ryusuke SUZUKI e35388b00e 2a617095b1 -> 7859bada69 2021-04-26 19:18:46 +09:00
Hans Petter Selasky 4b895a34bb Document __FreeBSD_version 1400007 through 1400010 2021-04-22 11:43:53 +02:00
Ka Ho Ng e457b6efe3 books/porters-handbook: Fix numerous mismatches in section 11.1
In step 1 users were told to do "cd ~/my_ports_wrkdir" but after clone
the repository users were instead told to do "cd ~/my_wrkdir". Also, the
git command in step 2 is not followed by either of them. The mirror
sites table is outdated as well.

This fix changes the whole shell code block to use the directory name
my_wrkdir. Also, the repository URL table xref replaces the old SVN
mirror sites xref.

Reported by:	Pau Amma <pauamma@gundo.com>
Approved by:	0mp
Differential Revision:	https://reviews.freebsd.org/D29916
2021-04-22 16:20:59 +08:00
Mateusz Piotrowski 16ca20a527 handbook: Make the Git URL table name more descriptive
"Handy URL Table" is not very informative when cross-referenced from
other parts of the documentation.

Reviewed by:	debdrup
Differential Revision:	https://reviews.freebsd.org/D29919
2021-04-22 09:55:25 +02:00
Fernando Apesteguía f82b1afba2 [committers-guide] Fix quotes
Follow-up for commit 5e5b9e25d7

Reported by: 0mp
Approved by: 0mp (mentor)
2021-04-22 09:40:14 +02:00
Fernando Apesteguía 5e5b9e25d7 [handbook] Show how to configure sleep on lid closure
Add information about how to make FreeBSD sleep and resume when the lid state
switches.

Approved By: 0mp (mentor)
Differential Revision: https://reviews.freebsd.org/D29897
2021-04-22 09:23:42 +02:00
Fernando Apesteguía a30982fef8 [committers-guide] Remove obsolete misc question
Adding files in Git does not requiere special considerations.

Approved by: 0mp
Differential Revision: https://reviews.freebsd.org/D29884
2021-04-22 08:28:34 +02:00
Fernando Apesteguía 0eb1ef29d9 [committers-guide] Fix typo
s/relese/release

Approved by: 0mp
Differential Revision: https://reviews.freebsd.org/D29889
2021-04-22 08:24:48 +02:00
Fernando Apesteguía 69fe0eea04 [committers-guide] Consistent use of Subversion
Majority of the uses capitalize the first letter. Let the rest do the same.

Approved by: 0mp
Differential Revision: https://reviews.freebsd.org/D29888
2021-04-22 08:22:52 +02:00
Fernando Apesteguía 8f3c366fd2 [committers-guide] Update src branches information
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
2021-04-21 18:39:58 +02:00
Ka Ho Ng 0a0df62229 books/porters-handbook: Fix git server link
https://git.FreeBSD.org is the correct URL to our git public server.

Reported by:	Hung-Yi Chen <gaod.chen@gmail.com>
Reviewed by:	delphij
Approved by:	lwhsu
Differential Revision:	https://reviews.freebsd.org/D29879
2021-04-21 16:10:36 +08:00
Fernando Apesteguía a0dabc992e [articles][vm-design] Add Spanish translation
Add the Spanish translation for the vm-design article.

Most of the work was done with Weblate[1]

Reviewed by: 0mp, carlavilla
Approved by: 0mp (mentor)
Differential Revision: https://reviews.freebsd.org/D29646

[1] https://translate-dev.freebsd.org/projects/documentation/articlesvm-design_index/es/
2021-04-20 17:45:07 +02:00
Mateusz Piotrowski 5755cad0f0 committers-guide: Fix indentation of commit message examples 2021-04-20 17:45:54 +02:00
Mateusz Piotrowski bcd1bb7a20 committers-guide: Remove "Submitted by" from examples
Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D29868
2021-04-20 17:45:19 +02:00
Mateusz Piotrowski ea68d93d5f committers-guide: Discourage use of Submitted by
The use of "Submitted by" is discouraged in all the source trees now.
2021-04-20 17:11:49 +02:00
Mateusz Piotrowski a527f32556 committers-guide: Bring back MFH metadata field
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
2021-04-20 14:56:44 +02:00
Ryusuke SUZUKI 9848bbc7ac 989d921f5d -> 2a617095b1 2021-04-20 21:50:12 +09:00
Pau Amma 7f37df0e34 handbook/mirrors: Fix a typo 2021-04-20 13:23:32 +02:00
Mateusz Piotrowski bb4bdb25db content/en: Use <<section>> for linking within a document
I've used the following script to locate all the cases where crossref
was used to link to a section within the same document:

  grep -R crossref: | while read -r case; do
      file=${case%%:*}
      dir=${file%/*}
      dir_name=${dir##*/}
      line=${case##*:}
      target_document=${line%%[*}
      if [ "$dir_name" = "$target_document" ]; then
          echo "$case"
      fi
  done
2021-04-20 12:49:32 +02:00
Mateusz Piotrowski ceee1def00 articles/committers-guide: Document change in MFH policy
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
2021-04-20 12:14:58 +02:00
Mateusz Piotrowski 32abed26b2 articles/committers-guide: Update "MFC with" description
We use Git hashes now, not revision numbers.
2021-04-20 11:58:39 +02:00
Fernando Apesteguía be6e85b4a2 [porters-handbook]: Clarify prefixes in patch file names
Patches must start with `patch-` in order to be applied automatically.
Conditional patches must not start with `patch-`.

PR: 24903
Reported by:	pauamma@gundo.com

Approved by: 0mp (mentor)
Differential Revision: https://reviews.freebsd.org/D28268
2021-04-20 11:42:36 +02:00
Li-Wen Hsu 6d2a97cf80
Fix path: s,/usr/local/shared,/usr/local/share,
PR:		255101
Reported by:	Christos Margiolis <christos@christosmarg.xyz>
Approved by:	carlavilla (implicitly)
2021-04-20 12:21:23 +08:00
Mark Johnston 6f71dc766b Clarify that the vendor merge commits should have proper commit messages
Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D29745
2021-04-19 15:54:02 -04:00
Mateusz Piotrowski 5dddbce327 FAQ: Do not explain how to get ports twice
Instead, point users to the appropriate chapter in the handbook.

I've named the anchor "ports-using-installation-methods" for consistency
with the existing ones. There is no need to break existing bookmarks.
At least for now.
2021-04-19 17:23:30 +02:00