Page MenuHomeFreeBSD

documentation: Add an option to archive/compress HTML offline files
ClosedPublic

Authored by dbaio on Nov 6 2021, 1:51 AM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 2 2024, 5:15 PM
Unknown Object (File)
Dec 13 2023, 5:06 AM
Unknown Object (File)
Nov 12 2023, 7:11 AM
Unknown Object (File)
Nov 8 2023, 10:48 PM
Unknown Object (File)
Nov 7 2023, 2:57 PM
Unknown Object (File)
Nov 6 2023, 5:53 AM
Unknown Object (File)
Oct 7 2023, 9:40 PM
Unknown Object (File)
Oct 6 2023, 1:43 PM
Subscribers

Details

Summary

The goal here is to update the ftp/doc [1] assets, which is outdated
since the migration to Hugo/Asciidoctor.

1 - https://download.freebsd.org/ftp/doc/

Test Plan
$ cd documentation
$ DOC_HTML_ARCHIVE=1 make html
$ make pdf

or faster:

$ cd documentation
$ DOC_LANG="en pt-br es" DOC_HTML_ARCHIVE=1 make html
$ DOC_LANG="en pt-br es" make pdf

Output:

$ tree public/
public
├── en
│   ├── articles
│   │   ├── bsdl-gpl
│   │   │   ├── bsdl-gpl_en.pdf
│   │   │   └── bsdl-gpl_en.tar.gz
│   │   ├── building-products
│   │   │   ├── building-products_en.pdf
│   │   │   └── building-products_en.tar.gz
│   │   ├── committers-guide
│   │   │   ├── committers-guide_en.pdf
│   │   │   └── committers-guide_en.tar.gz
│   │   ├── contributing
│   │   │   ├── contributing_en.pdf
│   │   │   └── contributing_en.tar.gz
│   │   ├── contributors
│   │   │   ├── contributors_en.pdf
│   │   │   └── contributors_en.tar.gz
│   │   ├── cups
│   │   │   ├── cups_en.pdf
│   │   │   └── cups_en.tar.gz
│   │   ├── explaining-bsd
│   │   │   ├── explaining-bsd_en.pdf
│   │   │   └── explaining-bsd_en.tar.gz
│   │   ├── filtering-bridges
│   │   │   ├── filtering-bridges_en.pdf
│   │   │   └── filtering-bridges_en.tar.gz
│   │   ├── fonts
│   │   │   ├── fonts_en.pdf
│   │   │   └── fonts_en.tar.gz
│   │   ├── freebsd-questions
│   │   │   ├── freebsd-questions_en.pdf
│   │   │   └── freebsd-questions_en.tar.gz
│   │   ├── freebsd-releng
│   │   │   ├── freebsd-releng_en.pdf
│   │   │   └── freebsd-releng_en.tar.gz
│   │   ├── freebsd-src-lsp
│   │   │   ├── freebsd-src-lsp_en.pdf
│   │   │   └── freebsd-src-lsp_en.tar.gz
│   │   ├── freebsd-update-server
│   │   │   ├── freebsd-update-server_en.pdf
│   │   │   └── freebsd-update-server_en.tar.gz
│   │   ├── geom-class
│   │   │   ├── geom-class_en.pdf
│   │   │   └── geom-class_en.tar.gz
│   │   ├── gjournal-desktop
│   │   │   ├── gjournal-desktop_en.pdf
│   │   │   └── gjournal-desktop_en.tar.gz
│   │   ├── hubs
│   │   │   ├── hubs_en.pdf
│   │   │   └── hubs_en.tar.gz
│   │   ├── ipsec-must
│   │   │   ├── ipsec-must_en.pdf
│   │   │   └── ipsec-must_en.tar.gz
│   │   ├── ldap-auth
│   │   │   ├── ldap-auth_en.pdf
│   │   │   └── ldap-auth_en.tar.gz
│   │   ├── leap-seconds
│   │   │   ├── leap-seconds_en.pdf
│   │   │   └── leap-seconds_en.tar.gz
│   │   ├── linux-emulation
│   │   │   ├── linux-emulation_en.pdf
│   │   │   └── linux-emulation_en.tar.gz
│   │   ├── linux-users
│   │   │   ├── linux-users_en.pdf
│   │   │   └── linux-users_en.tar.gz
│   │   ├── mailing-list-faq
│   │   │   ├── mailing-list-faq_en.pdf
│   │   │   └── mailing-list-faq_en.tar.gz
│   │   ├── nanobsd
│   │   │   ├── nanobsd_en.pdf
│   │   │   └── nanobsd_en.tar.gz
│   │   ├── new-users
│   │   │   ├── new-users_en.pdf
│   │   │   └── new-users_en.tar.gz
│   │   ├── pam
│   │   │   ├── pam_en.pdf
│   │   │   └── pam_en.tar.gz
│   │   ├── pgpkeys
│   │   │   └── pgpkeys_en.tar.gz
│   │   ├── port-mentor-guidelines
│   │   │   ├── port-mentor-guidelines_en.pdf
│   │   │   └── port-mentor-guidelines_en.tar.gz
│   │   ├── pr-guidelines
│   │   │   ├── pr-guidelines_en.pdf
│   │   │   └── pr-guidelines_en.tar.gz
│   │   ├── problem-reports
│   │   │   ├── problem-reports_en.pdf
│   │   │   └── problem-reports_en.tar.gz
│   │   ├── rc-scripting
│   │   │   ├── rc-scripting_en.pdf
│   │   │   └── rc-scripting_en.tar.gz
│   │   ├── releng
│   │   │   ├── releng_en.pdf
│   │   │   └── releng_en.tar.gz
│   │   ├── remote-install
│   │   │   ├── remote-install_en.pdf
│   │   │   └── remote-install_en.tar.gz
│   │   ├── serial-uart
│   │   │   ├── serial-uart_en.pdf
│   │   │   └── serial-uart_en.tar.gz
│   │   ├── solid-state
│   │   │   ├── solid-state_en.pdf
│   │   │   └── solid-state_en.tar.gz
│   │   ├── vinum
│   │   │   ├── vinum_en.pdf
│   │   │   └── vinum_en.tar.gz
│   │   └── vm-design
│   │       ├── vm-design_en.pdf
│   │       └── vm-design_en.tar.gz
│   └── books
│       ├── arch-handbook
│       │   ├── arch-handbook_en.pdf
│       │   └── arch-handbook_en.tar.gz
│       ├── design-44bsd
│       │   ├── design-44bsd_en.pdf
│       │   └── design-44bsd_en.tar.gz
│       ├── dev-model
│       │   ├── dev-model_en.pdf
│       │   └── dev-model_en.tar.gz
│       ├── developers-handbook
│       │   ├── developers-handbook_en.pdf
│       │   └── developers-handbook_en.tar.gz
│       ├── faq
│       │   ├── faq_en.pdf
│       │   └── faq_en.tar.gz
│       ├── fdp-primer
│       │   ├── fdp-primer_en.pdf
│       │   └── fdp-primer_en.tar.gz
│       ├── handbook
│       │   ├── handbook_en.pdf
│       │   └── handbook_en.tar.gz
│       └── porters-handbook
│           ├── porters-handbook_en.pdf
│           └── porters-handbook_en.tar.gz
├── es
│   ├── articles
│   │   ├── bsdl-gpl
│   │   │   ├── bsdl-gpl_es.pdf
│   │   │   └── bsdl-gpl_es.tar.gz
│   │   ├── building-products
│   │   │   ├── building-products_es.pdf
│   │   │   └── building-products_es.tar.gz
│   │   ├── contributing
│   │   │   ├── contributing_es.pdf
│   │   │   └── contributing_es.tar.gz
│   │   ├── contributors
│   │   │   ├── contributors_es.pdf
│   │   │   └── contributors_es.tar.gz
│   │   ├── cups
│   │   │   ├── cups_es.pdf
│   │   │   └── cups_es.tar.gz
│   │   ├── explaining-bsd
│   │   │   ├── explaining-bsd_es.pdf
│   │   │   └── explaining-bsd_es.tar.gz
│   │   ├── filtering-bridges
│   │   │   ├── filtering-bridges_es.pdf
│   │   │   └── filtering-bridges_es.tar.gz
│   │   ├── fonts
│   │   │   ├── fonts_es.pdf
│   │   │   └── fonts_es.tar.gz
│   │   ├── freebsd-questions
│   │   │   ├── freebsd-questions_es.pdf
│   │   │   └── freebsd-questions_es.tar.gz
│   │   ├── ipsec-must
│   │   │   ├── ipsec-must_es.pdf
│   │   │   └── ipsec-must_es.tar.gz
│   │   ├── leap-seconds
│   │   │   ├── leap-seconds_es.pdf
│   │   │   └── leap-seconds_es.tar.gz
│   │   ├── linux-users
│   │   │   ├── linux-users_es.pdf
│   │   │   └── linux-users_es.tar.gz
│   │   ├── mailing-list-faq
│   │   │   ├── mailing-list-faq_es.pdf
│   │   │   └── mailing-list-faq_es.tar.gz
│   │   ├── nanobsd
│   │   │   ├── nanobsd_es.pdf
│   │   │   └── nanobsd_es.tar.gz
│   │   ├── port-mentor-guidelines
│   │   │   ├── port-mentor-guidelines_es.pdf
│   │   │   └── port-mentor-guidelines_es.tar.gz
│   │   ├── pr-guidelines
│   │   │   ├── pr-guidelines_es.pdf
│   │   │   └── pr-guidelines_es.tar.gz
│   │   ├── problem-reports
│   │   │   ├── problem-reports_es.pdf
│   │   │   └── problem-reports_es.tar.gz
│   │   ├── releng
│   │   │   ├── releng_es.pdf
│   │   │   └── releng_es.tar.gz
│   │   ├── remote-install
│   │   │   ├── remote-install_es.pdf
│   │   │   └── remote-install_es.tar.gz
│   │   ├── solid-state
│   │   │   ├── solid-state_es.pdf
│   │   │   └── solid-state_es.tar.gz
│   │   ├── vinum
│   │   │   ├── vinum_es.pdf
│   │   │   └── vinum_es.tar.gz
│   │   └── vm-design
│   │       ├── vm-design_es.pdf
│   │       └── vm-design_es.tar.gz
│   └── books
│       ├── faq
│       │   ├── faq_es.pdf
│       │   └── faq_es.tar.gz
│       └── handbook
│           ├── handbook_es.pdf
│           └── handbook_es.tar.gz
└── pt-br
    ├── articles
    │   ├── bsdl-gpl
    │   │   ├── bsdl-gpl_pt-br.pdf
    │   │   └── bsdl-gpl_pt-br.tar.gz
    │   ├── building-products
    │   │   ├── building-products_pt-br.pdf
    │   │   └── building-products_pt-br.tar.gz
    │   ├── committers-guide
    │   │   ├── committers-guide_pt-br.pdf
    │   │   └── committers-guide_pt-br.tar.gz
    │   ├── contributing
    │   │   ├── contributing_pt-br.pdf
    │   │   └── contributing_pt-br.tar.gz
    │   ├── contributors
    │   │   ├── contributors_pt-br.pdf
    │   │   └── contributors_pt-br.tar.gz
    │   ├── cups
    │   │   ├── cups_pt-br.pdf
    │   │   └── cups_pt-br.tar.gz
    │   ├── explaining-bsd
    │   │   ├── explaining-bsd_pt-br.pdf
    │   │   └── explaining-bsd_pt-br.tar.gz
    │   ├── filtering-bridges
    │   │   ├── filtering-bridges_pt-br.pdf
    │   │   └── filtering-bridges_pt-br.tar.gz
    │   ├── fonts
    │   │   ├── fonts_pt-br.pdf
    │   │   └── fonts_pt-br.tar.gz
    │   ├── freebsd-questions
    │   │   ├── freebsd-questions_pt-br.pdf
    │   │   └── freebsd-questions_pt-br.tar.gz
    │   ├── freebsd-releng
    │   │   ├── freebsd-releng_pt-br.pdf
    │   │   └── freebsd-releng_pt-br.tar.gz
    │   ├── freebsd-update-server
    │   │   ├── freebsd-update-server_pt-br.pdf
    │   │   └── freebsd-update-server_pt-br.tar.gz
    │   ├── geom-class
    │   │   ├── geom-class_pt-br.pdf
    │   │   └── geom-class_pt-br.tar.gz
    │   ├── gjournal-desktop
    │   │   ├── gjournal-desktop_pt-br.pdf
    │   │   └── gjournal-desktop_pt-br.tar.gz
    │   ├── hubs
    │   │   ├── hubs_pt-br.pdf
    │   │   └── hubs_pt-br.tar.gz
    │   ├── ipsec-must
    │   │   ├── ipsec-must_pt-br.pdf
    │   │   └── ipsec-must_pt-br.tar.gz
    │   ├── ldap-auth
    │   │   ├── ldap-auth_pt-br.pdf
    │   │   └── ldap-auth_pt-br.tar.gz
    │   ├── leap-seconds
    │   │   ├── leap-seconds_pt-br.pdf
    │   │   └── leap-seconds_pt-br.tar.gz
    │   ├── linux-emulation
    │   │   ├── linux-emulation_pt-br.pdf
    │   │   └── linux-emulation_pt-br.tar.gz
    │   ├── linux-users
    │   │   ├── linux-users_pt-br.pdf
    │   │   └── linux-users_pt-br.tar.gz
    │   ├── mailing-list-faq
    │   │   ├── mailing-list-faq_pt-br.pdf
    │   │   └── mailing-list-faq_pt-br.tar.gz
    │   ├── nanobsd
    │   │   ├── nanobsd_pt-br.pdf
    │   │   └── nanobsd_pt-br.tar.gz
    │   ├── new-users
    │   │   ├── new-users_pt-br.pdf
    │   │   └── new-users_pt-br.tar.gz
    │   ├── pam
    │   │   ├── pam_pt-br.pdf
    │   │   └── pam_pt-br.tar.gz
    │   ├── pgpkeys
    │   │   └── pgpkeys_pt-br.tar.gz
    │   ├── port-mentor-guidelines
    │   │   ├── port-mentor-guidelines_pt-br.pdf
    │   │   └── port-mentor-guidelines_pt-br.tar.gz
    │   ├── pr-guidelines
    │   │   ├── pr-guidelines_pt-br.pdf
    │   │   └── pr-guidelines_pt-br.tar.gz
    │   ├── problem-reports
    │   │   ├── problem-reports_pt-br.pdf
    │   │   └── problem-reports_pt-br.tar.gz
    │   ├── rc-scripting
    │   │   ├── rc-scripting_pt-br.pdf
    │   │   └── rc-scripting_pt-br.tar.gz
    │   ├── releng
    │   │   ├── releng_pt-br.pdf
    │   │   └── releng_pt-br.tar.gz
    │   ├── remote-install
    │   │   ├── remote-install_pt-br.pdf
    │   │   └── remote-install_pt-br.tar.gz
    │   ├── serial-uart
    │   │   ├── serial-uart_pt-br.pdf
    │   │   └── serial-uart_pt-br.tar.gz
    │   ├── solid-state
    │   │   ├── solid-state_pt-br.pdf
    │   │   └── solid-state_pt-br.tar.gz
    │   ├── vinum
    │   │   ├── vinum_pt-br.pdf
    │   │   └── vinum_pt-br.tar.gz
    │   └── vm-design
    │       ├── vm-design_pt-br.pdf
    │       └── vm-design_pt-br.tar.gz
    └── books
        ├── dev-model
        │   ├── dev-model_pt-br.pdf
        │   └── dev-model_pt-br.tar.gz
        ├── faq
        │   ├── faq_pt-br.pdf
        │   └── faq_pt-br.tar.gz
        ├── fdp-primer
        │   ├── fdp-primer_pt-br.pdf
        │   └── fdp-primer_pt-br.tar.gz
        ├── handbook
        │   ├── handbook_pt-br.pdf
        │   └── handbook_pt-br.tar.gz
        └── porters-handbook
            ├── porters-handbook_pt-br.pdf
            └── porters-handbook_pt-br.tar.gz

117 directories, 214 files

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable