Page MenuHomeFreeBSD

documentation: fix WARN after hugo setings change
AcceptedPublic

Authored by vladlen on Wed, Jul 1, 6:26 PM.

Details

Reviewers
ziaee
carlavilla
Group Reviewers
doceng
Summary

All warnings in EN documentation fixed.
All warnings in RU documentation fixed too.

Corresponding places in all other languages also fixed
(if language had the same text translated).

Other languages still has a lot of invalid reference warnings,
these are real wrong links and should be fixed when
translation is updated.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

vladlen created this revision.

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

documentation/content/en/books/dev-model/_index.adoc
82

This macro does not work on this doc. The links are all dead, and also they will be formatted wrong with an extra space. For dev-model since these are all inter-doc xrefs, I think we should use simple asciidoctor xrefs. I tested them and both render correctly and the links work.

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)
  • In the books, books in chapters and full book (I forgot about this one :)
  • Offline website
  • PDFs
This revision is now accepted and ready to land.Thu, Jul 2, 9:48 AM
documentation/content/en/books/dev-model/_index.adoc
82

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.

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:

  1. 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.

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:

  1. 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.

Nah, no problem, proceed as you said ๐Ÿ’ƒ

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.