Gitlab pages instructions for Pelican needs work

[damascene]

I'm trying to use Pelican for my new project and things are working fine for the most part however I'm having issues so I decided to do some testing using Pelican template from Gitlab. I discovered few issues.

Display Issue

Local Version

Local version of the Pelican quick-start shows a nice version:

Gitlab Version

The version from gitlab after following instruction results in this:

Page live at:
https://testing_pelican.gitlab.io/

Source code:
https://gitlab.com/testing_pelican/testing_pelican.gitlab.io

backports-zoneinfo Issue

Before building I've fixed a backports-zoneinfo issue:

ERROR: Could not build wheels for backports-zoneinfo, which is required to install pyproject.toml-based projects

By increasing version of Alpine to:

image: python:3.9-alpine

Broken links

Links on the page are broken it directs to:

https://testing_pelican.gitlab.io/pelican/pelican-on-gitlab-pages.html

instead of:

https://testing_pelican.gitlab.io/pelican-on-gitlab-pages.html

Group or Username Site

Instruction doesn't explicitly say that you have to create the repository with name your_group.gitlab.io but it says you should rename. However renaming would keep the directory name intact and it that will have you visit the domain with subdirectory.

Allow Public Access to Pages

On Gitlab/pages you will notice a notification to allow public access in Giltab Settings/Visibility

Comment

I'm already running few pelican static websites and I've managed to use different theme but the default installation should at least show some beautiful working example.

[justinmayer]

Hi @damascene. Folks from the community kindly added support for Pelican to GitLab Pages, and I don't believe any of the core Pelican maintainers (myself included) have ever used said GitLab Pages integration. Perhaps @axilleas can chime in with ideas regarding the best place to report issues related to this integration effort?

[axilleas]

@damascene yep, like Justin suggested, please open an issue at https://gitlab.com/pages/pelican/-/issues.

I was in the process of updating the CI config, but haven't finished yet, I will try to pick it up next week.

I'll make sure to add a note in the readme to open issues in the GitLab issue tracker where the template resides.

However renaming would keep the directory name intact and it that will have you visit the domain with subdirectory.

We must rephrase that. You should really change the path of the project from its settings, not the name.