From nobody Sun Nov 21 16:31:18 2021 X-Original-To: freebsd-doc@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id A55A8188A9EA; Sun, 21 Nov 2021 16:31:30 +0000 (UTC) (envelope-from carlavilla@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [IPv6:2610:1c1:1:606c::24b:4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "smtp.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Hxwry3JRPz4StV; Sun, 21 Nov 2021 16:31:30 +0000 (UTC) (envelope-from carlavilla@freebsd.org) Received: from mail-ua1-f41.google.com (mail-ua1-f41.google.com [209.85.222.41]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "GTS CA 1D4" (verified OK)) (Authenticated sender: carlavilla) by smtp.freebsd.org (Postfix) with ESMTPSA id 528472CD40; Sun, 21 Nov 2021 16:31:30 +0000 (UTC) (envelope-from carlavilla@freebsd.org) Received: by mail-ua1-f41.google.com with SMTP id t13so31639197uad.9; Sun, 21 Nov 2021 08:31:30 -0800 (PST) X-Gm-Message-State: AOAM530vtFrWTPeMhmyvZP3lPiosZ8EfkBMzSuIM5Ra6xDo25VFDsHwd 3YW3rqu9Q3OtUGLPCj1opxmKZaq2UktH4/F+ZFM= X-Google-Smtp-Source: ABdhPJy6F2RvpFYrWaD1tWRnHKYprVd3VaW5Z73/t28hopH/rZn8bTSwN4LGAewxKV5qDAhSumHbziYRApwp1TVCKEk= X-Received: by 2002:ab0:66cd:: with SMTP id d13mr74833895uaq.140.1637512289908; Sun, 21 Nov 2021 08:31:29 -0800 (PST) List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@freebsd.org MIME-Version: 1.0 From: Sergio Carlavilla Date: Sun, 21 Nov 2021 17:31:18 +0100 X-Gmail-Original-Message-ID: Message-ID: Subject: FreeBSD Documentation Portal status and review request To: "freebsd-doc@FreeBSD.org" , freebsd-translators@freebsd.org Content-Type: text/plain; charset="UTF-8" X-ThisMailContainsUnwantedMimeParts: N Dear FreeBSD community, A couple of months ago we added information about the new FreeBSD Documentation Portal to the quarterly reports[1]. Well, at this time there's some things that need to be accomplished in the new Documentation Portal. For example a local search using Algolia[2] as Hugo[3] or AsciiDoctor[4] does. Algolia provides a free version for Open Source projects[5]. And the dark theme. Apart from that, you can see the new Documentation Portal here[6]. I used my personal VPS to deploy the documentation portal temporarily to show to the community since I have problems with Gitlab and Docker. I didn't add all the languages because the bandwidth and the disk size is very limited. I have the cheapest VPS in Digital Ocean hehe. To summarize the changes you are going to find: - Completely new responsive design. Tested in FreeBSD and all other major OS. - Removed Python from the dependencies. - Removed the list of figures, tables and examples. Do you think these lists are useful? In this case I'll restore it using the AsciiDoctor API instead of Python. This change will not be as traumatic as the previous one, it will not be necessary to freeze the repository or change the technology used to build the documentation. The existing theme will "just" be modified. Please let me know your thoughts about this :) I'm gonna send this message to the documentation and translators list to reach more people. The next steps will be: - Finish the dark theme (1 more week) - Implement Algolia to use it for local searches (1 more week) - Use mandoc to generate the manual pages - Redesign the ports page - Redesign of the FreeBSD main website Bye! [1] https://www.freebsd.org/status/report-2021-07-2021-09/#_freebsd_website_revamp_webapps_working_group [2] https://www.algolia.com [3] https://gohugo.io/ [4] https://docs.asciidoctor.org/home/ [5] https://www.algolia.com/for-open-source/ [6] https://carlavilla.es