From e4d7f0a9d95cf2816e4c0b2b59849f49766e05dc Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Wed, 29 May 2024 07:28:22 +0200 Subject: [PATCH] Docs: GitHub Pages workflow not officially supported --- .github/workflows/github_pages.yml | 1 + docs/tips.rst | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/github_pages.yml b/.github/workflows/github_pages.yml index eb9e955f..f4a01b92 100644 --- a/.github/workflows/github_pages.yml +++ b/.github/workflows/github_pages.yml @@ -1,3 +1,4 @@ +# Workflow for publishing to GitHub Pages. **NO OFFICIAL SUPPORT PROVIDED.** name: Deploy to GitHub Pages on: workflow_call: diff --git a/docs/tips.rst b/docs/tips.rst index 904e5ee7..3344900d 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -126,8 +126,9 @@ branch of your GitHub repository:: Publishing to GitHub Pages Using a Custom GitHub Actions Workflow ----------------------------------------------------------------- -Pelican comes with a `custom workflow `_ -for publishing a Pelican site. To use it: +Pelican-powered sites can be published to GitHub Pages via a `custom workflow +`_. +**No official support is provided** for this community-submitted workflow. To use it: 1. Enable GitHub Pages in your repo: go to **Settings → Pages** and choose **GitHub Actions** for the **Source** setting.