From cd654df609dc05752d50e23ebe3d410085bdc477 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 5 Aug 2024 12:39:33 -0400 Subject: [PATCH] [CI] Don't check links under Windows (#2064) --- layouts/partials/community_links.html | 3 ++- userguide/content/en/docs/adding-content/content.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/layouts/partials/community_links.html b/layouts/partials/community_links.html index 4f0505ebc2..7a033fc395 100644 --- a/layouts/partials/community_links.html +++ b/layouts/partials/community_links.html @@ -1,4 +1,5 @@ {{ $links := .Site.Params.links -}} +{{ $contribUrl := .Params.contributingUrl | default "docs/contribution-guidelines" -}} diff --git a/userguide/content/en/docs/adding-content/content.md b/userguide/content/en/docs/adding-content/content.md index 9c5d605050..c9f458c52d 100644 --- a/userguide/content/en/docs/adding-content/content.md +++ b/userguide/content/en/docs/adding-content/content.md @@ -599,6 +599,16 @@ params: If you're creating your own site and want to add a page using this template, add a `/community/_index.md` file in your content root directory. If you've copied the example site and *don't* want a community page, just delete the `/content/en/community/` directory in your project repo. +By default, Docsy layouts assume that your project's contributing page is found +at `/docs/contribution-guidelines`. To specify another URL, add it to +the front matter of `/community/_index.md` as illustrated next. The URL can be +an external URL or a local path: + +```yaml +params: + contributingUrl: docs/contributing/ +``` + ## Adding static content You may want to serve some non-Hugo-built content along with your site: for example, if you have generated reference docs using Doxygen, Javadoc, or other doc generation tools.