From nobody Thu May 11 20:26:58 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4QHNjG2pPqz49ytT for ; Thu, 11 May 2023 20:26:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4QHNjG2Fkrz3vNs; Thu, 11 May 2023 20:26:58 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683836818; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Pu5rn0Lj3GPaFOEpQYl2FJqDZ7wbyRF6DrbdoAWbpOs=; b=KFmX4wZkLpXwlYbhWhUV5LDEQyMCCQ3SHLmYkvc5TJc13E33eCX1w9X8mMfJDM+MeghFyu P/aL6hoxYRCF5qt/hOMBQZMklSyQhiSj/42DjOZaW5zHGQ79ckRZEiCqJmbuVqW0Cipg67 HUqM6NwvzknjoZfumD0EsDWky2rQk8V95FBdC47/Uuby8LU5LKL89IE6eR1pJqg+yeoL7k 7r4LZuTyX+eroaQ9n3shP9as3pZrr/Rcfc5Yl9e5SFYSnHjYC42SEntP/u8Vyv/6g3CWhG A0tAka8L9fmaug9cVUlD+nurdGZcOSry2MaAJEjF2nevZUz9cop7hPo2JaffRQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683836818; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Pu5rn0Lj3GPaFOEpQYl2FJqDZ7wbyRF6DrbdoAWbpOs=; b=QMBRet5368F6GWILimldqy0pYqPv7nNMTWw+jtEC2gC3yO7+4bY51gC03LNktVu7NEsQ/y 8ZmpqiAeaqbWQlPKdx6I2q09nyHNgJ3vVmTfdMf+m/Q8uFbm5BojFs6F7NznWtsalBPXcO oNzNSdmVM70KJ1r4vrcM/m2qF1URcnR28GirrR3Wv8eGxH3VdcV9NOZ8JcS/DeZ1YfWmEE 2wRWzwSjIX/PCk8itLafyeSEehsjttsd+a26VvDWYaeAtMxFcug2Efg69PtW9pr2oWPB2K B//lbEJ4n7663l608DVtYrQiY82aAhhxYXsU5duwmG0yr0cQOqI9NJvRViPQFw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683836818; a=rsa-sha256; cv=none; b=jWnNqM20/T97/QJnv0IQNPXIJZAqI8c8kTVf/0+NQ1t6oRCIkQRNC5OfrOg514JdWlaaLe V5pJ7kfMOMSuBjydeU+yX7qSqJ7MBl5CVqE/xiKR4B+8LhaTNPu+S1J8qGRV9JnlG8rYyM M4Q9my2HfSsmp7DS7LBVEgzD4/pfCN8uJconQY3dp5fRLog8GFfdZZyC4M/LkmUYGvNYEt 2YmJ32BeP8+j2Mrt/FJWNZ05Ra/ySRwJGs3BhSTtyofxg8qrUaJ9HiH6kQ4s3wQMr/QjST 9pxRhfI7IiHfQsvrACOKMkDy0Rz+2BuS5YdroBAsj5kzvJlkW6GESyuQJrgY0A== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4QHNjG1JJ2z16Js; Thu, 11 May 2023 20:26:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 34BKQwwb052464; Thu, 11 May 2023 20:26:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34BKQwGk052463; Thu, 11 May 2023 20:26:58 GMT (envelope-from git) Date: Thu, 11 May 2023 20:26:58 GMT Message-Id: <202305112026.34BKQwGk052463@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ceri Davies Subject: git: 41a7d1606e - main - fdp-primer/writing-style: redo some parts of rev 2f4edf696b List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ceri X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 41a7d1606e49829d12e1ddcfe5c17401db06d7e6 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by ceri: URL: https://cgit.FreeBSD.org/doc/commit/?id=41a7d1606e49829d12e1ddcfe5c17401db06d7e6 commit 41a7d1606e49829d12e1ddcfe5c17401db06d7e6 Author: Ceri Davies AuthorDate: 2023-05-11 20:24:20 +0000 Commit: Ceri Davies CommitDate: 2023-05-11 20:24:20 +0000 fdp-primer/writing-style: redo some parts of rev 2f4edf696b --- .../content/en/books/fdp-primer/writing-style/_index.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index 935025d090..fe9d704a8b 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -309,7 +309,7 @@ Similarly, every major vendor and company has specific rules on writing their br Care should be taken to be respectful to the brand value of others and to take time to write PostgreSQL, Node.js, Let's Encrypt etc. Missing brand names should be added to the [.filename]#.vale/styles/FreeBSD/BrandTerms.yml# in the `doc` repository. -. FreeBSD.ConsciousLanguage: This rule proposes use of conscious languages so that sensitive words pointing to the color, age, race, sexual orientation of people are avoided where possible. +. FreeBSD.ConsciousLanguage: This rule proposes use of conscious language so that sensitive words pointing to the color, age, race, or sexual orientation of people are avoided where possible. . FreeBSD.Contractions: Contracted words should not be used. This rule avoids all contractions and suggests full words. @@ -326,14 +326,14 @@ This rule proposes better wording. . FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL. . Vale.Avoid: Enforces the *DO NOT USE* vocabulary terms for The FreeBSD Project. -If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository. +If any word is found that should not be in the documentation, the word should be added to [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository. The list is empty at the moment. . Vale.Repetition: Same words are often typed twice when leaving the keyboard and rejoining the work again. This rule finds repeated words and warns the users. -. Vale.Spelling: At the moment there is a mix of en_US and en_UK spellings in the documentation and website. -Vale comes with an in built dictionary from which uses strictly en_US and do not accept the en_UK variant of any words. +. Vale.Spelling: At the moment there is a mix of en_US and en_GB spellings in the documentation and website. +Vale comes with an in built dictionary from which uses strictly en_US and do not accept the en_GB variant of any words. . Vale.Terms: Enforces the *PREFERRED* vocabulary terms for The FreeBSD Project. At the moment the list of terms is empty and the FreeBSD specific terms will be added gradually.