From 3f181531df21b4b331a6bfc8411b664a9521619e Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Thu, 1 Apr 2021 12:00:43 -0700 Subject: [PATCH] README.md: link to external formatting of user manual Some people don't like htmlpreview.github.io. I once or twice saw a case where it appeared to be affected by load limits. Since external sites are making the manual available, and it's unlikely there are too many changes between the last release and the current manual, just link to it as an alternative for folks. Signed-off-by: Elijah Newren --- Documentation/git-filter-repo.txt | 4 +++- README.md | 5 +++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Documentation/git-filter-repo.txt b/Documentation/git-filter-repo.txt index 6aa2a8ac..2abbead0 100644 --- a/Documentation/git-filter-repo.txt +++ b/Documentation/git-filter-repo.txt @@ -1,7 +1,9 @@ // This file is NOT the documentation; it's the *source code* for it. // Please follow the "user manual" link under // https://github.com/newren/git-filter-repo#how-do-i-use-it -// to access the actual documentation. +// to access the actual documentation, or view another site that +// has compiled versions available, such as: +// https://www.mankier.com/1/git-filter-repo git-filter-repo(1) ================== diff --git a/README.md b/README.md index 0caa34f2..b20a0c1b 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,11 @@ section](https://htmlpreview.github.io/?https://github.com/newren/git-filter-rep commands](Documentation/converting-from-bfg-repo-cleaner.md#cheat-sheet-conversion-of-examples-from-bfg), which covers every example from the BFG website +External sites also have [alternative formats of the user +manual](https://www.mankier.com/1/git-filter-repo) available, at least +for the most recent release. This also may be beneficial if +htmlpreview.github.io starts hitting load limits. + # Why filter-repo instead of other alternatives? This was covered in more detail in a [Git Rev News article on