IdeaList [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
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|AllanJude]], [[/DaniloBaio|DaniloBaio]] and [[/LiWenHsu|LiWenHsu]]. The legacy pages (www-legacy.f.o) are still active. | COMPLETED |
| Resync www mirrors | They are outdated, more details here: [[https://docs.freebsd.org/en/articles/hubs/#mirror-www|Mirroring the WWW Pages]] - [[https://docs.freebsd.org/en/books/handbook/eresources/#eresources-web|Official Mirrors]] - bit0.us-west.freebsd.org was updated by clusteradm (2021-07-12). | COMPLETED | [[/DaniloBaio|DaniloBaio]], [[/LiWenHsu|LiWenHsu]] |
| Update assets on [[https://download.freebsd.org/ftp/doc/|download.f.o/ftp/doc]] | Generate PDF, EPUB, HTML archive for each document. See bug [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=256526|#256526]] | COMPLETED | [[/DaniloBaio|DaniloBaio]], [[/PhilipPaeps|PhilipPaeps]] |
| Update [[https://www.freebsd.org/cgi/ports.cgi?query=freebsd-doc&stype=all|misc/freebsd-doc*]] ports | Package all assets on each language port. | COMPLETED | blackend |

====== Website ======

^ 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 [[https://www.freebsd.org/press/feed.xml|Press RSS]] - [[https://www.freebsd.org/news/feed.xml|News RSS]] - And it's missing a # in all press links. | COMPLETED | [[/DaniloBaio|DaniloBaio]] |
| FAQ Working Group | [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=266111#c1|Holistic review, template to start anew]] (2022-09-20), duration maybe thirteen weeks. [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=266111#c11|Completed 2023-10-11]]. | [[https://reviews.freebsd.org/D41644#961940|COMPLETED]] | carlavilla |

====== Translation ======

^ Task ^ Description ^ Status ^ Responsible ^
| Weblate project for Documentation | Enable project and send announcement.[[https://translate-dev.freebsd.org/projects/documentation/|Documentation Project]] | COMPLETED | [[/DaniloBaio|DaniloBaio]] |
| Weblate Project for Website | Enable project and send announcement. This is in progress while we have open issues in the workflow. [[https://translate-dev.freebsd.org/projects/website/|Website Project]] | - | - |
| Weblate %%FreeBSD%% addon or Admin command | This is necessary to adjust components properly, right now I'm executing this manually. [[https://gist.github.com/dbaio/1de2235e35a2f5bb3363b54dbba4d36e|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, [[https://cgit.freebsd.org/doc/tree/documentation/content/pt-br/articles/explaining-bsd/_index.adoc#n23|pt-br articles/explaining-bsd]]. We need that in the original document, otherwise the workflow with po4a won't work properly. Commit [[https://cgit.freebsd.org/doc/commit/?id=64acd169b82416fe39ad8c4b1be106680d4a3eb3|64acd169s]] covers this. | COMPLETED | [[/DaniloBaio|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. [[https://github.com/WeblateOrg/weblate/pull/5764|weblate PR5764]] - [[https://gist.github.com/dbaio/1de2235e35a2f5bb3363b54dbba4d36e|Weblate FreeBSD notes (gist)]]. | COMPLETED | [[/DaniloBaio|DaniloBaio]] |
| po4a: Fix YAML Front Matter / tags and trademarks | More details on [[Doc/Translation/Weblate/Documents]] and  [[https://github.com/freebsd/freebsd-doc/blob/main/tools/translate.sh#L27-L36|temporary fix]], [[https://github.com/mquinson/po4a/issues/354|po4a 354]]. | COMPLETED | [[/DaniloBaio|DaniloBaio]], [[/FernandoApesteguia|FernandoApesteguia]] |
| po4a: Do not work properly with tables and callouts | More details on [[Doc/Translation/Weblate/Documents]] and [[https://github.com/mquinson/po4a/issues/351|po4a 351]], [[https://github.com/mquinson/po4a/issues/353|po4a 353]]. | COMPLETED | [[/DaniloBaio|DaniloBaio]] |
| po4a: Include issue when there is a ''%%{{% lang %}}%%'' variable | More details on [[https://github.com/mquinson/po4a/issues/352|po4a 352]]. | COMPLETED | [[/DaniloBaio|DaniloBaio]] |
| Weblate Repository | Move Weblate repository to the %%FreeBSD%% organization. doc-br/freebsd-doc-translate --> freebsd/freebsd-doc-translate | COMPLETED | [[/DaniloBaio|DaniloBaio]], [[/BaptisteDaroussin|BaptisteDaroussin]] |

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

====== Handbook ======

^ Task ^ Description ^ Status ^ Responsible ^
| Add mdoc to FDP Primer | [[https://mdocml.bsd.lv/man/mdoc.7.html]] - item imported from #bsddocs | - | - |

====== Misc ======

^ Task ^ Description ^ Status ^ Responsible ^
| - | - | - | - |

----

{{tag>Docs Todo}}