aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/serial-uart
Commit message (Collapse)AuthorAgeFilesLines
* doc: Add source .po files for translationsDanilo G. Baio2022-08-071-0/+3064
| | | | | | | | | | | | | | | | | | This helps the Weblate translation workflow and offline translations through .po files, it's important to update these files constantly. The goal here is to have a semi-automated translation workflow; Weblate will pull updates automatically from the main repository and commit translations to another repository. Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. $ ./tools/update_translate_template.sh documentation Anyway, I'll keep doing this periodically. Discussed with: doceng
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-031-11/+16
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* Revert "Add Hugo's lang shortcode"Danilo G. Baio2021-06-191-3/+3
| | | | | | | This reverts commit 3462d12db6ebf303064db168a2333374344f369a. Too soon, it broke asciidoctor-pdf which doesn't know Hugo's shortcode. It will take more time and care.
* Add Hugo's lang shortcodeDanilo G. Baio2021-06-191-3/+3
| | | | | | | | | | | | | | | | | | This is a prerequisite for the translation workflow through .po files and Weblate. The asciidoctor include with the shortcode variable will help because won't be needed to change the includes manually after converting the translation (.po file) back to .adoc. It will help other areas like, language attributes, which today is fixed in every document. The use of shortcode was suggested by jmooring@ from Hugo's project on Github. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30823
* Remove an extra space after '+' charactersDanilo G. Baio2021-06-081-4/+4
| | | | | | | | | | | | | This is happening only on documentation/, basically in all places that attaches a block or a paragraph to a list [1]. Although this is working, it impacts our translation tool po4a, the '+' character is a difficult part when processing asciidoc[tor] files. 1 - https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30688
* en/articles/*: Set includes paths according to the backend used for theMarc Fonvieille2021-05-191-0/+13
| | | | | build. This fixes the PDF versions.
* Improve SEO with the keywors meta tagSergio Carlavilla Delgado2021-05-041-0/+1
| | | | | | Add in all articles and books the tag list. Modify the theme to use the tag list defined in articles and books to generate the keywords meta tag
* Improve descriptions for some books and articlesAllan Jude2021-05-021-1/+1
| | | | | | | | | | Also add weights to some, to define the sort order in the index Put the more commonly used items at the top of their respective lists The improved descriptions were taken from the old books/articles list: https://www.freebsd.org/docs/books/ Sponsored-By: Klara Inc.
* Improve the SEO of the documentation portalSergio Carlavilla Delgado2021-05-011-1/+1
| | | | | | | Changes: - Add the description meta tag in the index, articles and books - Add a brief description in each article and book. - Remove the SVN expansion tag
* Fix typos, style and images pathsSergio Carlavilla Delgado2021-03-201-86/+235
| | | | | Global review of styles, typos and images paths in gjournal-desktop, releng, vinum and vm-design
* Use correct syntax markup for shellLi-Wen Hsu2021-03-141-8/+8
| | | | Approved by: carlavilla
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-251-0/+1014
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core