Re: Migration of git-scm.com to a static web site: ready for review/testing
From: Todd Zullinger <hidden>
Date: 2023-11-17 16:26:44
Hello, Johannes Schindelin wrote:
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/.
This is nice. Thanks to all for working on it! For checking links, a tool like linkcheker[1] is very handy. This is run against the local docs in the Fedora package builds to catch broken links. I ran it against the test site and it turned up _a lot_ of broken links. It's enough that saving and sharing the output is probably more work than having someone familiar with the migration give it a run directly. I ran `linkchecker https://git.github.io/git-scm.com/` and the eventual result was: That's it. 13459 links in 14126 URLs checked. 0 warnings found. 6763 errors found. Stopped checking at 2023-11-17 11:11:17-004 (1 hour, 19 minutes) The default output reports failures in a format like this: URL `ch00/ch10-git-internals' Name `Git Internals' Parent URL https://git.github.io/git-scm.com/book/tr/v2/Ek-b%C3%B6l%C3%BCm-C:-Git-Commands-Plumbing-Commands/, line 106, col 1318 Real URL https://git.github.io/git-scm.com/book/tr/v2/Ek-b%C3%B6l%C3%BCm-C:-Git-Commands-Plumbing-Commands/ch00/ch10-git-internals Check time 3.303 seconds Size 1KB Result Error: 404 Not Found LinkChecker can be run in a mode which directs the failures to a file. That would be more like: linkchecker -F text/utf_8//tmp/git-scm-check.txt https://git.github.io/git-scm.com/ The format of the -F option is TYPE[/ENCODING][/FILENAME] where TYPE can be text, html, sql, csv, gml, dot, xml, sitemap, none or failures. The failures type is much more terse: 1 "('https://git.github.io/git-scm.com/book/en/v2/Appendix-C:-Git-Commands-Plumbing-Commands/', 'https://git.github.io/git-scm.com/book/en/v2/Appendix-C:-Git-Commands-Plumbing-Commands/ch00/ch10-git-internals')" I found the text type much more helpful in quickly spot checking some of the failures since it includes the text string used for the link. Running it against a local directory of the content would be a lot faster, if that's an option. It's also worth bumping the default number of threads from 10 to increase the speed a bit. [1] https://linkchecker.github.io/linkchecker/ -- Todd