From 963ddc994a55da075a512a358c55e15240d72b75 Mon Sep 17 00:00:00 2001 From: Patrick Kollitsch <83281+davidsneighbour@users.noreply.github.com> Date: Sun, 26 Dec 2021 21:58:21 +0700 Subject: [PATCH] docs: add a link to the mailmap documentation I find that Hugo should contain more links to relevant documentation of features in other tools/documentations. Please let me know if we don't want that and I'll stop. In this specific case I read about `.mailmap` in the Hugo docs and as a developer knew what was meant, but I think less dev-y users might not understand this. Instead of starting to add paragraphs about the format maybe it's ok to link to the features docs? As I said, let me know if that is overkill/bloat. It would make my life easier than seeing a word and googling it :) (for instance, if we link to git in this case we don't need to add extra-documentation about what the mailmap file should look like and what should be in there) --- content/en/variables/git.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/variables/git.md b/content/en/variables/git.md index 59ee9ac88..58a285fd9 100644 --- a/content/en/variables/git.md +++ b/content/en/variables/git.md @@ -37,10 +37,10 @@ The `GitInfo` object contains the following fields: : the abbreviated commit hash (e.g., `866cbcc`) .AuthorName -: the author's name, respecting `.mailmap` +: the author's name, respecting [`.mailmap`](https://git-scm.com/docs/gitmailmap) .AuthorEmail -: the author's email address, respecting `.mailmap` +: the author's email address, respecting [`.mailmap`](https://git-scm.com/docs/gitmailmap) .AuthorDate : the author date