This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 07b859b Setup Pelican Properly
07b859b is described below
commit 07b859bb9583bd30a5fe28d5994d53e4f89bcad8
Author: Dave Fisher <[email protected]>
AuthorDate: Thu Mar 6 14:52:40 2025 -0800
Setup Pelican Properly
---
.github/workflows/build-pelican.yml | 8 +++-
pelicanconf.py | 74 +++++++++++++++++++++++++++++++++++++
2 files changed, 80 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/build-pelican.yml
b/.github/workflows/build-pelican.yml
index 69ec7fb..1638bb7 100644
--- a/.github/workflows/build-pelican.yml
+++ b/.github/workflows/build-pelican.yml
@@ -1,17 +1,21 @@
name: Build a Pelican Website
on:
push:
- branches: [ "main" ]
+ # This prevents the workflow from running automatically on a new branch
+ # When creating a new site branch, please ensure that the push and
checkout branches agree
+ # and that the action/pelican destination value is updated accordingly
+ branches: [ 'main' ]
workflow_dispatch:
jobs:
build-pelican:
runs-on: ubuntu-latest
- continue-on-error: true
steps:
- uses: actions/checkout@v4
with:
+ # This must equal the push/branches list above, and be appropriate
for the destination below
ref: 'main'
- uses: apache/infrastructure-actions/pelican@main
with:
+ # This must be appropriate for the branch being built
destination: 'asf-site'
gfm: 'true'
diff --git a/pelicanconf.py b/pelicanconf.py
new file mode 100644
index 0000000..a91adf4
--- /dev/null
+++ b/pelicanconf.py
@@ -0,0 +1,74 @@
+
+import datetime
+# Basic information about the site.
+SITENAME = 'ASF Tooling Website'
+SITEDESC = 'The official website of the ASF Tooling Team'
+SITEDOMAIN = 'tooling.apache.org'
+SITEURL = 'https://tooling.apache.org'
+SITELOGO = 'https://tooling.apache.org//extras/favicon.ico'
+SITEREPOSITORY = 'https://github.com/apache/tooling-docs/blob/main/content/'
+CURRENTYEAR = datetime.date.today().year
+TRADEMARKS = 'Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.'
+TIMEZONE = 'UTC'
+# Theme includes templates and possibly static files
+THEME = 'content/theme'
+# Specify location of plugins, and which to use
+PLUGIN_PATHS = [ 'plugins', ]
+# If the website uses any *.ezmd files, include the 'gfm' and 'asfreader'
plugins (in that order)
+PLUGINS = [ 'toc', 'spu', 'gfm', 'asfgenid', 'asfrun', ]
+# All content is located at '.' (aka content/ )
+PAGE_PATHS = [ 'pages' ]
+STATIC_PATHS = [ '.', ]
+# Where to place/link generated pages
+
+PATH_METADATA = 'pages/(?P<path_no_ext>.*)\\..*'
+
+PAGE_SAVE_AS = '{path_no_ext}.html'
+# Don't try to translate
+PAGE_TRANSLATION_ID = None
+# Disable unused Pelican features
+# N.B. These features are currently unsupported, see
https://github.com/apache/infrastructure-pelican/issues/49
+FEED_ALL_ATOM = None
+INDEX_SAVE_AS = ''
+TAGS_SAVE_AS = ''
+CATEGORIES_SAVE_AS = ''
+AUTHORS_SAVE_AS = ''
+ARCHIVES_SAVE_AS = ''
+# Disable articles by pointing to a (should-be-absent) subdir
+ARTICLE_PATHS = [ 'blog' ]
+# needed to create blogs page
+ARTICLE_URL = 'blog/{slug}.html'
+ARTICLE_SAVE_AS = 'blog/{slug}.html'
+# Disable all processing of .html files
+READERS = { 'html': None, }
+
+# Configure the asfgenid plugin
+ASF_GENID = {
+ 'unsafe_tags': True,
+ 'metadata': False,
+ 'elements': False,
+ 'permalinks': False,
+ 'tables': False,
+
+ 'headings': False,
+
+
+ 'toc': False,
+
+ 'debug': False,
+}
+
+
+
+
+
+# Configure the asfrun plugin (finalization)
+ASF_POSTRUN = [ '/bin/bash pagefind.sh', ]
+
+
+# Configure ignore files
+# File and directory basenames matching any of these patterns will be ignored
by the processor.
+IGNORE_FILES = [ 'theme', ]
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
