Infrastructure

You were redirected here from DocIdeaList.

Here are some TODO items for The FreeBSD Documentation Project. Some of these are smaller tasks, which are relatively easy to solve and some are more complicated, longer term tasks.

Note: Just because an idea is on this page it does not mean there is guarantee that there exists a consensus that the idea is a good one.

See the old list in IdeaListOld.

Task	Description	Status	Responsible
Redirect links for the new Documentation	At this moment almost 100% of English legacy links are redirected to the new Documentation as 301 Moved Permanently. Initial work made by AllanJude, DaniloBaio and LiWenHsu. The legacy pages (www-legacy.f.o) are still active.	COMPLETED
Resync www mirrors	They are outdated, more details here: Mirroring the WWW Pages - Official Mirrors - bit0.us-west.freebsd.org was updated by clusteradm (2021-07-12).	COMPLETED	DaniloBaio, LiWenHsu
Update assets on download.f.o/ftp/doc	Generate PDF, EPUB, HTML archive for each document. See bug #256526	COMPLETED	DaniloBaio, PhilipPaeps
Update misc/freebsd-doc* ports	Package all assets on each language port.	COMPLETED	blackend

Task	Description	Status	Responsible
New design for the documentation portal	Create a new design for the Documentation Portal. Reponsive. Dark mode.	COMPLETE	carlavilla
New design for the website	Create a new design for the Website. Reponsive. Dark mode.	-	carlavilla
Remove python dependency	Use the AsciiDoctor API instead the Python scripts to generate the different TOCs	COMPLETE	carlavilla
Manual pages portal	Generate the manual pages portal using mandoc	In Progress	carlavilla
Ports portal	Generate a ports portal	-	carlavilla
Links for Events/News/Press (RSS) are not unique	See Press RSS - News RSS - And it's missing a # in all press links.	COMPLETED	DaniloBaio
FAQ Working Group	Holistic review, template to start anew (2022-09-20), duration maybe thirteen weeks. Completed 2023-10-11.	COMPLETED	carlavilla

Task	Description	Status	Responsible
Weblate project for Documentation	Enable project and send announcement.Documentation Project	COMPLETED	DaniloBaio
Weblate Project for Website	Enable project and send announcement. This is in progress while we have open issues in the workflow. Website Project	-	-
Weblate FreeBSD addon or Admin command	This is necessary to adjust components properly, right now I'm executing this manually. Weblate FreeBSD notes (gist)	-	-
Translate .toml files	We can't translate them right now with po4a/Weblate, migrate to .adoc is a way.	-	-
Variables for includes based on languages	This will fix the includes and attributes issues which we are repeating in basically all documents. Example of attributes just in the translated documents, pt-br articles/explaining-bsd. We need that in the original document, otherwise the workflow with po4a won't work properly. Commit 64acd169s covers this.	COMPLETED	DaniloBaio, carlavilla
Weblate Automatic Translation	Script for executing Weblate Automatic Translations for all languages; this will be used after all updates in the source files. weblate PR5764 - Weblate FreeBSD notes (gist).	COMPLETED	DaniloBaio
po4a: Fix YAML Front Matter / tags and trademarks	More details on Documents and temporary fix, po4a 354.	COMPLETED	DaniloBaio, FernandoApesteguia
po4a: Do not work properly with tables and callouts	More details on Documents and po4a 351, po4a 353.	COMPLETED	DaniloBaio
po4a: Include issue when there is a `{{% lang %}}` variable	More details on po4a 352.	COMPLETED	DaniloBaio
Weblate Repository	Move Weblate repository to the FreeBSD organization. doc-br/freebsd-doc-translate –> freebsd/freebsd-doc-translate	COMPLETED	DaniloBaio, BaptisteDaroussin