Re: articles/hubs: Update WWW mirroring section

From: Danilo G. Baio <dbaio_at_FreeBSD.org>
Date: Mon, 11 Apr 2022 23:43:46 UTC
FYI

This just reflects the reality.

https://docs.freebsd.org/en/articles/hubs/#mirror-www



On Mon, Apr 11, 2022 at 11:33:47PM +0000, Danilo G. Baio wrote:
> The branch main has been updated by dbaio:
> 
> URL: https://cgit.FreeBSD.org/doc/commit/?id=68b40e34553002f86a41d007281e1a25422e7f4a
> 
> commit 68b40e34553002f86a41d007281e1a25422e7f4a
> Author:     Danilo G. Baio <dbaio@FreeBSD.org>
> AuthorDate: 2022-03-05 13:14:59 +0000
> Commit:     Danilo G. Baio <dbaio@FreeBSD.org>
> CommitDate: 2022-04-11 23:29:26 +0000
> 
>     articles/hubs: Update WWW mirroring section
>     
>     Differential Revision:  https://reviews.freebsd.org/D34454
> ---
>  documentation/content/en/articles/hubs/_index.adoc | 23 ++++++++++++++++++++--
>  1 file changed, 21 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/content/en/articles/hubs/_index.adoc b/documentation/content/en/articles/hubs/_index.adoc
> index 1e2c9da25a..9c5bf2506e 100644
> --- a/documentation/content/en/articles/hubs/_index.adoc
> +++ b/documentation/content/en/articles/hubs/_index.adoc
> @@ -214,14 +214,33 @@ If you sync the whole module (unlike subdirectories), be aware that the module-d
>  [[mirror-www]]
>  === Mirroring the WWW Pages
>  
> -The FreeBSD website should only be mirrored via rsync.
> +[WARNING]
> +====
> +Since doc migration to Hugo/Asciidoctor on 2021-01-25, mirroring the website with rsync no longer works.
> +====
> +
> +There are ongoing studies to implement a website mirror with the extref:{handbook}mirrors/[official infrastructure].
> +
> +For the former website mirrors, a way to achieve mirroring the website today is building the website locally with the corresponding address it will be hosted.
> +
> +[source,shell]
> +....
> +% cd website && env HUGO_baseURL="https://www.XX.freebsd.org/" make
> +....
>  
> -A command line to mirror the FreeBSD web site might look like:
> +Check for more details about the build tools on extref:{fdp-primer}overview/[FreeBSD Documentation Project Primer for New Contributors, overview-quick-start] book.
>  
> +////
>  [source,shell]
>  ....
>  % rsync -vaHz --delete rsync://bit0.us-west.freebsd.org/FreeBSD-www-data/ /usr/local/www/
>  ....
> +////
> +
> +[NOTE]
> +====
> +Notice the website was split into www.FreeBSD.org and docs.FreeBSD.org, and there are links between them; plus, at this moment, `HUGO_baseURL` variable won't cover all links, this way, mirroring the website is discouraged.
> +====
>  
>  [[mirror-pkgs]]
>  === Mirroring Packages
> 


Regards.
-- 
Danilo G. Baio (dbaio)