apache / apache/infrastructure-pelican
Documentation for pelicanconf.yaml is scattered around and incomplete
- Dominant language
- Python
- Stars
- 3
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
There does not appear to be a definitive document that describes the contents of pelicanconf.yaml.
There are several partial documents, but these are not complete:
- https://infra.apache.org/asf-pelican-config.html which references
- https://github.com/apache/template-site
Note that neither of them describe what the site/index entry is for.
Nor is the new postrun feature documented.
Given that the file is processed by buildsite.py in this repo, it would seem sensible to document the syntax here.
For example by creating a same yaml file with all the possible entries.
This could even be used in unit tests.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading buildsite.py and comparing its configuration handling with the linked ASF Pelican configuration and template-site documents. Create a definitive reference or example YAML covering the supported entries, including site/index and postrun, and determine from the repository whether it can also serve as a unit-test fixture.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100