Details
Diff Detail
- Repository
- R9 FreeBSD doc repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
The content is the same for all files that are also in the GitHub repository. There are however a few more changes:
- the file file status/report-2022-07-2022-09/_index.adoc has been created;
- the file status/_index has been updated.
Applying the proposed patch is also useful to run make run in the website directory and see a rendered version of the report, so that some kind of errors are easier to spot (e.g. section misalignments).
| website/content/en/status/report-2022-07-2022-09/cloud-init.adoc | ||
|---|---|---|
| 15 | extref:{handbook}[FreeBSD Handbook] fails to render properly when running make run. Does anybody know how to fix it? Would it fail to render in production too? | |
| website/content/en/status/report-2022-07-2022-09/cloud-init.adoc | ||
|---|---|---|
| 15 | It works in production, I think. See eg, in https://docs.freebsd.org/en/articles/committers-guide/#_building, the link to the Handbook. (The anchor is wrong*, but it will still take you to the Handbook. Is that what you were asking?) \* That happens elsewhere, eg in https://docs.freebsd.org/en/articles/contributing/#contrib-general. | |
Re-open review: a link to the handbook does not render properly.
| website/content/en/status/report-2022-07-2022-09/cloud-init.adoc | ||
|---|---|---|
| 15 | Unfortunately it is broken in production too, see https://www.freebsd.org/status/report-2022-07-2022-09/#_freebsd_as_a_tier_1_cloud_init_platform . I guess extref:{handbook}[FreeBSD Handbook] requires to include some file that is missing. I have tried adding :lang: en
include::shared/{lang}/urls.adoc[]as suggested in https://docs.freebsd.org/en/books/fdp-primer/asciidoctor-primer/#asciidoctor-links but it still does not work. Any clue? Thanks. | |
I'm not in front of my laptop now. In 2 hours.
But, add this:
include::shared/en/urls.adoc[]
And to make a reference to the handbook:
link:{handbook}[The FreeBSD Handbook]
Try with this. I'll try it later.
It works, thanks @carlavilla. I will update the _index.adoc template for quarterly reports to always include shared/en/urls.adoc so we do not get into this issue anymore.
However, I still wonder why extref did not work and we needed to switch it to link.
Thanks.
(I had previously sped through the rendered previews in GitHub, so I didn't look at non-rendered content here.)
I probably assumed that extref signifies a reference to something external, which would have suited the FreeBSD Handbook (at docs.freebsd.org) being external to status reports (at www.freebsd.org).
On closer inspection: the extref example that I followed is for an Internal link.
This leaves me wondering: what (if not external) is signified by ext …