Re: To be deprecated [.filename]## tag in the document?

2023-01-31 Thread Pau Amma
[trimmed ccs and quoted text] On 2023-01-31 08:02, Mathieu Arnold wrote: On Mon, Jan 30, 2023 at 12:43:27PM +0100, Sergio Carlavilla wrote: On Mon, 30 Jan 2023 at 12:31, Mathieu Arnold wrote: > > On Mon, Jan 30, 2023 at 11:36:05AM +0100, Sergio Carlavilla wrote: > > El jue., 26 ene. 2023

Re: Documentation of /usr/src directory layout

2022-10-26 Thread Pau Amma
On 2022-10-26 16:07, Mitchell Horne wrote: Hello, Currently, hier(7) contains detailed but outdated [1] documentation of the directory structure under /usr/src. The src tree's README.md file duplicates much of this information by maintaining a distinctly incomplete table. Noting that (on 13.1

Re: git: e5b116889d - main - doc: Add source .po files for translations

2022-08-08 Thread Pau Amma
On 2022-08-07 13:53, Danilo G. Baio wrote: Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. Do the FDP primer and or the Committer's Guide need a mention of this? -- #BlackLivesMatter #TransWomenAreWomen

Quotes around the .Nd argument in 1/6 of manual pages

2022-07-27 Thread Pau Amma
The examples in https://docs.freebsd.org/en/books/fdp-primer/manual-pages/#manual-pages-sample-structures use quotes around the .Nd argument, but only about 1/6 of actual manual pages (outside contrib/) use them: ~/FreeBSD/src% git grep -E '^\.Nd "[^ ]* ' | grep -v -E '^contrib/' | wc -l #

Re: Revisiting the section 4 manual pages loader.conf boilerplate language?

2022-06-04 Thread Pau Amma
On 2022-06-04 07:18, Bjoern A. Zeeb wrote: On Fri, 3 Jun 2022, Pau Amma wrote: Currently, 3 section 4 manual pages say to use kld_list in rc.conf for loading: acpi_video(4), iwlwifi(4), and rtw88(4). Contrasting this with 367 following share/examples/mdoc/example.4's lead and instructing

Revisiting the section 4 manual pages loader.conf boilerplate language?

2022-06-03 Thread Pau Amma
Currently, 3 section 4 manual pages say to use kld_list in rc.conf for loading: acpi_video(4), iwlwifi(4), and rtw88(4). Contrasting this with 367 following share/examples/mdoc/example.4's lead and instructing to use loader(8)-time loading, the current approach appears to be: loader(8)-time

Follow-up to the FreeBSD Handbook improvement survey

2022-04-20 Thread Pau Amma
ebsd.org/bugzilla/show_bug.cgi?id=257481: (no images in epub) if still applicable - https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=257404: review or otherwise move forward Original Message Subject: FreeBSD Handbook improvement survey Date: 2022-04-16 13:04 From: Pau Amma To

FreeBSD Handbook improvement survey

2022-04-16 Thread Pau Amma
The FreeBSD Foundation contracted me to develop a prioritized plan for improving and updating the FreeBSD Handbook. For the first stage of this project, I have identified a number of issues needing improvement. To prioritize the issues, please tell me which are important to you personally.

Re: Translating the FreeBSD Documentation to Indonesian

2022-03-08 Thread Pau Amma
On 2022-03-08 05:25, Azrael JD wrote: Greetings, I would like to translate the FreeBSD documentation to Indonesian. Please let me know where to start, as there is no one listed on the documentation project's translation teams page that are translating the FreeBSD documentation to Indonesian.

Re: FreeBSD Documentation Portal status and review request

2021-12-15 Thread Pau Amma
Better late than never? I just noticed that (at least in the Porter's Handbook - I haven't checked others) there's no anchor for chapters themselves, only sections under them, and thus no way to link to a whole chapter. While you can link to the first subsection instead, that assumes no text

RFD: disambiguating online manual page name collisions between different ports

2021-12-01 Thread Pau Amma
Summary: Two recent Bugzilla reports about poor UX caused by manual page name collisions between different ports (https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=256676 and https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=254466) were both closed as "Works As Intended". I think the current

Re: FreeBSD Documentation Portal status and review request

2021-11-22 Thread Pau Amma
On 2021-11-22 22:16, Rocky Hotas wrote: On nov 21 17:31, Sergio Carlavilla wrote: And the dark theme. Apart from that, you can see the new Documentation Portal here[6]. - A dark theme would be very useful (and also very cool!). Agreed, especially for photosensitive users (accessibility).

Re: Adding a chapter about accessibility in the handbook?

2021-09-23 Thread Pau Amma
On 2021-09-23 17:41, Rannug Blah wrote: On Thu, Sep 23, 2021 at 5:29 PM Pau Amma wrote: *nod* Good point. I was thinking about making the FreeBSD installer itself do it but your approach works instead (or in addition) and would be much quicker to implement and release. Even better if we

Re: Adding a chapter about accessibility in the handbook?

2021-09-23 Thread Pau Amma
On 2021-09-23 16:58, Rannug Blah wrote: Yeah I know it's easy to get the package, what I'm referring to is that the average user might find it too cumbersome to do, as you have to now; install the package, find and pick a codex out of a list of many which you don't know anything about, manually

Re: Adding a chapter about accessibility in the handbook?

2021-09-23 Thread Pau Amma
On 2021-09-23 11:26, Rannug Blah wrote: On Wed, Sep 22, 2021 at 1:10 AM Pau Amma wrote: I for one don't think you are. Would you be willing and able to contribute draft language or review a draft addition? I think so, I already set up a VM and am messing around with yasr and stuff, I

Re: Adding a chapter about accessibility in the handbook?

2021-09-21 Thread Pau Amma
On 2021-09-21 17:12, Rannug Blah wrote: I was browsing through the amazing volume that is the handbook and realized that you have as far as I can tell no section about accessibility. So I felt I should mention the need, just a simple chapter about setting up yasr or something and providing

Re: Apparent inconsistency in FDP primer section 6.4

2021-07-21 Thread Pau Amma
On 2021-07-21 13:45, Ceri Davies wrote: On Tue, Jul 20, 2021 at 06:35:24PM +, Pau Amma wrote: "6.4.1. Ordered lists" is an example of a bulleted list and "6.4.2. Unordered lists" is an example of a numbered list, but I would expect "ordered" to refer to

Apparent inconsistency in FDP primer section 6.4

2021-07-20 Thread Pau Amma
"6.4.1. Ordered lists" is an example of a bulleted list and "6.4.2. Unordered lists" is an example of a numbered list, but I would expect "ordered" to refer to numbered lists and "unordered" to bulleted lists. Am I missing something? (Unless someone tells me I am, I'll either open a bug or -

Respecting DOCDIR in share/xml/urls.ent vs. documenting constraints on it in the FDP primer

2020-06-08 Thread Pau Amma
Executive summary: The '' line in share/xml/urls.ent doesn't respect DOCDIR, but I'm not sure whether and how to best fix it (in the toolchain or in the FDP primer), or even if it needs to be fixed at all (eg I could be missing something). Longer version, lightly paraphrased and expanded from

fop not installed as a dependency of the docproj package

2019-12-28 Thread Pau Amma
While trying to duplicate the PDF output error reported in https://reviews.freebsd.org/D22708#502794 (using "make FORMATS=pdf" in ~/doc/en_US.ISO8859-1/books/handbook), I got the following error instead: ... /usr/bin/env FOP_OPTS="-Xss1024k -Xmx1431552k" /usr/local/bin/fop -c

Re: Why is the text I'm adding not taking?

2019-11-13 Thread Pau Amma
On Wed, November 13, 2019 2:59 am, Pau Amma wrote: > [...} > Why? Did I make a mistake I'm not seeing? Never mind. Turns out that "~docobj" and "~/docobj" are not the same. ___ freebsd-doc@freebsd.org mailing list https:/

Why is the text I'm adding not taking?

2019-11-12 Thread Pau Amma
Following a Freenode IRC discussion with tsoome on the unadvisability of using whole disks in vdevs, I wanted to add the following to en_US.ISO8859-1/books/handbook/zfs/chapter.xml: Using an entire disk as part of a bootable pool is

Re: Building website wanders outside DESTDIR

2019-11-02 Thread Pau Amma
On Sat, November 2, 2019 4:55 am, Danilo G. Baio wrote: > On Sat, Nov 02, 2019 at 04:05:26AM -0000, Pau Amma wrote: >> >> % env DESTDIR=/usr/home/pauamma/docobj make all install >> >> This gave me, after a while: > > Try DOCDIR instead of DESTDIR. Thanks, tha

Building website wanders outside DESTDIR

2019-11-01 Thread Pau Amma
So I decided to try making a minor change to the FreeBSD Handbook myself, and to test it, I ran (from ~/doc where the raw files live): % env DESTDIR=/usr/home/pauamma/docobj make all install This gave me, after a while: /bin/mv pgpkeyring.txt.tmp pgpkeyring.txt Warning: Object directory not

RFD: suggested changes to "A project model for the FreeBSD Project"

2019-10-31 Thread Pau Amma
I just finished reading through https://www.freebsd.org/doc/en_US.ISO8859-1/books/dev-model/ for the first time, and I believe it would be a better document with some or all of the following changes, not all of which I have the required information to specify completely: - The text should use

Re: Which comma style does the FreeBSD handbook use? Or is that up to individual contributors and editors?

2019-10-08 Thread Pau Amma
On Tue, October 8, 2019 3:45 pm, Benjamin Kaduk wrote: > https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guidelines.html > says "use the serial comma". Thanks. ___ freebsd-doc@freebsd.org mailing list

Which comma style does the FreeBSD handbook use? Or is that up to individual contributors and editors?

2019-10-05 Thread Pau Amma
I've seen examples of both styles in the handbook, eg https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/audit-administration.html and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-usb-tethering.html, so I'm unsure. Important note: I'm only asking which one (if not

Mention of DEVELOPER=yes out of place/redundant in section 6.10.1 of the Porter's Handbook?

2019-09-18 Thread Pau Amma
https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/using-gnome.html (in 6.10.1. Introduction) contains a mention of adding DEVELOPER=yes to /etc/make.conf that to me looks out of place and redundant with that in section 3,