Date: Sun, 21 Nov 2021 16:43:56 -0300 From: "Danilo G. Baio" <dbaio@FreeBSD.org> To: Fernando =?utf-8?Q?Apestegu=C3=ADa?= <fernando.apesteguia@gmail.com> Cc: Sergio Carlavilla <carlavilla@freebsd.org>, "freebsd-doc@FreeBSD.org" <freebsd-doc@freebsd.org> Subject: Re: FreeBSD Documentation Portal status and review request Message-ID: <20211121194356.2ifvmlvyht4nrmmu@t480.local> In-Reply-To: <CAGwOe2aisYPLcwqhZJs2A0uo=J1gtP8J8Eg3==NhZN45wKuf3Q@mail.gmail.com> References: <CAFwocyO9GEUXno%2BewzkEVkoE1Fx_14ChO7NwU=wW2hQeiA0OcQ@mail.gmail.com> <CAGwOe2aisYPLcwqhZJs2A0uo=J1gtP8J8Eg3==NhZN45wKuf3Q@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--jpzo4oxsmyl2vpzn Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sun, Nov 21, 2021 at 07:03:48PM +0100, Fernando Apestegu=EDa wrote: > On Sun, Nov 21, 2021 at 5:31 PM Sergio Carlavilla > <carlavilla@freebsd.org> wrote: > > > > 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 Hu= go[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 maj= or 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. >=20 > I like it very much. Thanks for working on this! Thanks, Sergio, it is looking very nice. =3D) >=20 > A few details: >=20 > The "community" link seems broken. It points to > https://carlavilla.es/en/communit >=20 > Font size at the fourth level of the titles seems a bit small to me. > See the size difference between: >=20 > 3.2.2. Maintainer responsibilities >=20 > and >=20 > 3.2.2.1. Keep your ports up to date ---> This looks a bit small >=20 > in https://carlavilla.es/en/articles/contributing/ >=20 > Can this be configured or do we rely on changing the font size in the bro= wser? We can let the trademark/copyright part be more formal and different =66rom the rest of the text. >=20 > My last question is about Algolia. I'm not familiar with it. Why do we > plan to use it? What does it provide that Google or Duck Duck Go do > not? I'm not talking about Algolia or the other options [1] for the search engine, but the idea here is to provide a custom search engine/page into the documentation portal, like this [1]. The menu and table of content make it easy to navigate through the documents' sections. In the future, a search option in the page header will be excellent as well. The edit page button will be handy; we need to define the contributions process through Github/Gitlab/etc. Regards. 1 - https://gohugo.io/tools/search/ 2 - https://ubuntu.com/server/docs --=20 Danilo G. Baio (dbaio) --jpzo4oxsmyl2vpzn Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQKTBAABCgB9FiEEORj0UTsjzCy+enIkmpN7LfMuiNcFAmGaoXlfFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDM5 MThGNDUxM0IyM0NDMkNCRTdBNzIyNDlBOTM3QjJERjMyRTg4RDcACgkQmpN7LfMu iNd79BAAmlL2bmtP+9f70hU72pSU4y/iAlIn7K463JmJqkk4WGC6PKIptxmlkyur 7BZ+sPqBpbnqbZPPxct1c5LmQ4kHFuu4wERxmr2YC4pWEply3p+NHA5gE+/NF0d3 PKkWqUGlTvWSnLWYqPIR2bgtykLjm3VFFtHiq7TAjg7zHmA/g3nmusdSeo0r9ZZk 2LEZsxq7Rvy4u49ugwCf4C5uDdB+0bSz2RNOeYVbYp10UyAvz2b1ssWFhRa6cVmi rMIXZGfAycl2BszuCvfv48jzYF/igrhPwaYJEQ5XluC/3yDhmekptvXDH8IfmpLZ OWaN5m6GNwq4oItzzyUT1tkh/Eb5bpwIvdffyQroyH7bahfoLe253yfJVuOnZ2vt 660RBJ2Pra0sO3rnOtqfz9hCuLgGsQbLDv6KfyhzYWXnIXJfnS9ERVVF+A6HtNoJ ztmpD3J/PpAY3Su0tog8biPfxhoGs0IePTXIhp9pfTKUl+gW3lc09ynYS4xNfmjK /X6Frf765DboZ0D4b75DRzjLHGKxsjS5p4u7ndZAj2NZW2GD28JtB8cBYctPAuiH hS94mC1Y8DC1oz2+2KSJu6bA1IzXrRG+OeE/3Mxq2MeTkIOvWfQ2FW3aX9SmLmV6 m2ROrywGfzug9cI65sQth/qKOHVHAkw4q0h5fA3UBfi9WctoW44= =QYg4 -----END PGP SIGNATURE----- --jpzo4oxsmyl2vpzn--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20211121194356.2ifvmlvyht4nrmmu>