I'll make the commit this night or tomorrow

Improvements

In D58166#1334136, @dudleyi_yahoo.com wrote:

@carlavilla this seems to be a problem spread across multiple handbook languages. I did not scrub through them all, but I am sure there are more instances of this issue.

I'm going to make the commit, thanks

In D57999#1330765, @vladlen wrote:

In D57999#1330255, @ziaee wrote:

Do you see any problems with them?

It seems you pushed this commit already and it is live on https://docs.freebsd.org/en/books/dev-model/, where the links work. However local build with cd documentation; make, the links do not work, whereas they links do work for local build in handbook. Also, the appearance is wrong for that page because there are padded spaces some places and not other places. Maybe we can do something like \[crossref:dev-model[ref-freebsd-trenches, Lehey 2002]\] for the appearance? I do not know why the links are broken in offline build though.

I will check it. I checked it locally with cd documentation; make run and
looked at it in a browser.

I tried using \[ , but the output rendered as \[ literally.

Probably we could change the link style. Links like [1] were used in old
books, and now they are mostly used in scientific articles. Square brackets
are special symbols in AsciiDoc, and we will spend more time fighting with
them than using them comfortably.

In D57999#1330089, @vladlen wrote:

In D57999#1330069, @ziaee wrote:

In D57999#1330065, @carlavilla wrote:

In D57999#1330057, @ziaee wrote:

Dude you rock! Aside from dev-model, all the changes LGTM.

if the macro is broken, I need to fix it. But I created this macros coz we have these scenarios:

• Online website (freebsd.org, docs.freebsd.org)
• Offline website
• PDFs

It works everywhere else I checked except dev-model.

This links had 2 problems:
[crossref:dev-model[freebsd-send-pr, FreeBSD, 2002D]]

1. The same, as in website - it started and finished by square bracket

and simply disappeared from output (considered as AsciiDoc command).
I fixed this, they appeared, and I saw second problem:

2. The text FreeBSD, 2002D rendered as FreeBSD, everything

after comma were ignored. I removed comma and text is renderd correctly.
This comma is only for refference style, it does not have any special meaning.
With this changes all these links work correctly at least in HTML.

Do you see any problems with them?

P.S. Original article used reference style [FreeBSD, 2002D] long before AsciiDoc
was choosen for FreeBSD documentation, and now [ and ] chars need special treatment
in adoc files, or we are free to rename all these links.

In D57725#1330090, @vladlen wrote:

In D57725#1323489, @ziaee wrote:

1. 20 is too short. Can we have 50?
2. why does this combine security and errata if we have two separate feeds for that?
3. can we please put the actual content in these?

I can make additional RSS-feed for SA and EN pages (they both have default RSS feed with 0 items),
it could be additional task, but our colleagues ask to fix this interface.
Could we proceed with it?

In D57999#1330057, @ziaee wrote:

Dude you rock! Aside from dev-model, all the changes LGTM.

is quick.toml the right name for this? -> TBH, I think no :D, maybe we can find another name
should we bring back the config directory to put both of the tomls? -> hmmm, maybe yes

My apologies then.
Can you upload again the diff with only these changes?
I want to test it in my machine.

Sorry, I cannot see the file coz it's too long.

I should also mention that I've looked at the segments and partial caches[1], and compilation time hasn't improved.

I've been looking into this.
I think the simplest solution would be:

If you do this. Will be impossible to change the theme in the future

In D57722#1323618, @vladlen wrote:

In D57722#1323579, @ziaee wrote:

Can we fix https://www.freebsd.org/status/feed.xml instead of adding a new one?

This file is the template exactly for this link. Hugo uses naming convention
[section name].[type].xml (type is 'rss')
status.xml changes RSS-feed for all '/status' pages from default template.
The link https://gohugo.io/templates/rss/#custom-templates

Other names:
status.rss.xml
rss.xml

Coz if you put in two, you will break the current """"API""""", people will complain

I cannot download the patch and build it in my local machine.
These days I am busy with personal issues.

In D57051#1310344, @ziaee wrote:

Honestly, this section was broken and is still broken, because the section is called "choosing an image" but it does not explain the images. BASIC-CI, the most FAQ, now has a disclaimer that it is not what the reader intuitively thinks is, which is a doc smell, due to the an extremely unequal weighting of information where no other VM image is even explained at all. Cloudinit images are not mentioned, and they are the hot thing right now. The difference between DVD1 vs disc1 is not explained at all, so people will still ask questions about what those are.

In D57165#1310335, @ziaee wrote:

In D57165#1310053, @carlavilla wrote:

For me is ok, the simplest, the better, but wait for more reviews please

who do you think i should get to review this and why?

@vladlen, can we move this?

For me is ok, the simplest, the better, but wait for more reviews please

Update diff with changes requested

For me is ok, if you don't mind, can we commit in this order:

• https://reviews.freebsd.org/D57051
• https://reviews.freebsd.org/D57161 (without the choosing section)
• https://reviews.freebsd.org/D57165

For the section "Choosing an Image", I prefer to go with this one: https://reviews.freebsd.org/D57051
I think the change in this review is too much.
The other changes, I am ok.

For me is ok, thanks for the improvements you are making to this tool

In D56646#1309125, @vladlen wrote:

In D56646#1299250, @ziaee wrote:

Sorry I didn't have time to review this. This is absolutely wonderful, thank you so much for doing this. I wanted this for a long time but couldn't make it myself. Could you make the links also bold to match the drivers without manuals?

@ziaee

Hi Alex,
I am preparing the next fix for this script (replace '\[' to '[' , mandoc generates \[, if driver descrition has [ in the text).

I could also add the feature you are asking for.
Now hardware-notes-processor.rb generates messages to stdout and skips processing.
The current list for 15.1R is:

WARNING: The manual page man4.i386/ep does not exists

WARNING: The manual page man4.i386/ex does not exists

WARNING: The manual page man4.i386/fe does not exists

WARNING: The manual page hme does not exists

WARNING: The manual page pcn does not exists

WARNING: The manual page sf does not exists

WARNING: The manual page sn does not exists

WARNING: The manual page tl does not exists

WARNING: The manual page txp does not exists

WARNING: The manual page man4.i386/vx does not exists

WARNING: The manual page wb does not exists

WARNING: The manual page xe does not exists

WARNING: The manual page man4.i386/ce does not exists

WARNING: The manual page man4.i386/cx does not exists

WARNING: The manual page man4.i386/cp does not exists

WARNING: The manual page man4.i386/ctau does not exists

WARNING: The manual page ufintek does not exists

I have other proposal.
If line
&hwlist.man4.i386/ep;
generates this warning

WARNING: The manual page man4.i386/ep does not exists

then I can put this line again into the hardware.adoc. It can be easily found by '&hwlist' string.

1. If this driver is not supported by this release, then this line can be manually removed one time.
2. if driver supported by it does not have HARDWARE section, this line will be updated

next time, when HARDWARE section added before reease date.

3. If HARDWARE section is not added, this line will be removed day before release.

In this case hardware.adoc will be improved during every run
make generate-hardware-notes
One times to copy from template and every run to add new HARDWARE sections.

What do you think?

Do it like this by now, we will think in a final solution later

for me is ok, but the JavaScript is yours, put your name in the copyright :)

Go ahead, and also with the change in the JavaScript for the website.
I put a comment in the other review.

For me is ok, but please, put in an external javascript file and add it in the head

Put it in the header and as a separate file please.

In D57024#1307248, @fernape wrote:

Ya que decimos "porter" probablemente debamos dejar "ports".

Por cierto, ¿cómo puedo ver el resultado después de aplicar los cambios? DOC_LANG=es make run me muestra la página en inglés.

In D57024#1307248, @fernape wrote:

Ya que decimos "porter" probablemente debamos dejar "ports".

Por cierto, ¿cómo puedo ver el resultado después de aplicar los cambios? DOC_LANG=es make run me muestra la página en inglés.

In D51904#1189567, @lwhsu wrote:

The Torrents page contains both latest production and legacy release versions so we may need to mention this in both places, perhaps under the table of each -RELEASE, or putting in the "Choosing an Image" section. For the wording I suggest saying something like The magnet links to download via BitTorrent protocol are available at link:https://wiki.freebsd.org/Torrents[FreeBSD Torrents Wiki page].