Re: Migration of git-scm.com to a static web site: ready for review/testing

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Nov 18, 2023, 09:46 UTC
Message-ID: <70C3012B-95A2-411F-8DEF-B3B81E1F2DFD@gmx.de>
In-Reply-To: <39f863b9-fc81-43ca-93f5-89e341e8615d@kdbg.org>

Hi Hannes,

Yes, keeping existing deep links working is very much a goal of this work.

Thank you, Johannes

-------- Original Message --------
From: Johannes Sixt <j6t@kdbg.org>
Sent: November 18, 2023 10:41:11 AM GMT+01:00
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: git@vger.kernel.org, Matt Burke <spraints@gmail.com>, Victoria Dye <vdye@github.com>, "Matthias Aßhauer" <mha1993@live.de>
Subject: Re: Migration of git-scm.com to a static web site: ready for review/testing

Am 17.11.23 um 14:25 schrieb Johannes Schindelin:

Show 30 quoted lines

> Hi,
> 
> the idea of migrating https://git-scm.com/ from a Rails app to a static
> site has been discussed several times on this list in the past.
> 
> Thanks to the heroic, multi-year efforts of Matt Burke, Victoria Dye and
> Matthias Aßhauer, there is now a Pull Request, ready for review:
> https://github.com/git/git-scm.com/pull/1804
> 
> This Pull Request is not for the faint of heart, mainly because of the
> sheer amount of generated pages that are committed to the repository (such
> as the book, the manual pages, etc, a design decision necessary to run
> this as a static website).
> 
> These pages are generated by GitHub workflows that are intended to run on
> a schedule, and the scripts that generate them are part of the Pull
> Request. For that reason, I do not consider it necessary to review those
> generated pages, those reviews have been done in the upstream sources from
> which the pages were generated.
> 
> At this point, the patches are fairly robust and I am mainly hoping for
> help with verifying that the static site works as intended, that existing
> links will continue to work with the new site (essentially, find obscure
> references to the existing website, then insert `git.github.io/` in the
> URL and verify that it works as intended).
> 
> To that end, I deployed this branch to GitHub Pages so that anyone
> interested (hopefully many!) can have a look at
> https://git.github.io/git-scm.com/ and compare to the existing
> https://git-scm.com/.

When a transition to static pages happens, an important aspect is that external links that point into git-scm.com must not be invalidated. There are many such links in Stackoverflow answers, for example.

I checked one link:

https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt--r https://git.github.io/git-scm.com/docs/git-rebase#Documentation/git-rebase.txt--r

and it is looking very good. Thank you! I assume that keeping links working is not just a happy accident, but part of the plan.

-- Hannes