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 Doc/IdeaListOld.

Infrastructure

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.

In Progress

DaniloBaio

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

-

-

Update misc/freebsd-doc* ports

Package all assets (previous item) on each language port.

-

-

Website

Task

Description

Status

Responsible

New design for the documentation portal

Create a new design for the Documentation Portal. Reponsive. Dark mode.

In Progress

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

-

carlavilla

Manual pages portal

Generate the manual pages portal using mandoc

-

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

Translation

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

In Progress

DaniloBaio

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. I already received some advice about this, WIP.

In Progress

DaniloBaio

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)

In Progress

DaniloBaio

For old Weblate related items, see Doc/Translation/Weblate#Status.

Handbook

Task

Description

Status

Responsible

Add mdoc

https://mdocml.bsd.lv/man/mdoc.7.html - item imported from #bsddocs

-

-

Misc

Task

Description

Status

Responsible

-

-

-

-


CategoryDocs CategoryTodo

Doc/IdeaList (last edited 2021-07-16T22:28:10+0000 by DaniloBaio)