Any ASF project can use the ASF-Pelican template as the basis for their project website.
Review the Apache Template example to see whether the template's features will support the functions you need for your project
Note: this information is evolving.
Review the code repository for ASF-Pelican to confirm that it may provide the features your project site needs.
Create a Jira ticket for Infra, requesting Infra to create a repository using this template for your project. Provide a name and short description for the repository. Infra will confirm the repository's location when it is ready for you.
Note: we strongly suggest that you do your site development in a branch rather than the trunk of the repository, and then merge the branch into the trunk when you are sure that everything as working as you would like it. Each commit to the trunk triggers an automatic build to update your live site; this is great for trivial changes like correcting typos, but more of a challenge if you are making major changes and it turns out that there is an error in your code that disables your live site.
Review ASF Pelican feature branches.
theme/apache/templates, update the theme's
base.html to fit your site's requirements.
The example has the following frameworks.
For fenced code highlighting, have a look at highlightjs.
content/imagesfolder holds example logo files. Place your other site image files here.
Determine if your site requires a data model.
Edit your configuration
asfgenid.pyperforms a series of html fixups including permalinks, heading ids, and table of contents
Create your content
.mdfiles using Github Flavored Markdown (gfm
.ezmdfiles for templates using
When you are ready to use this repository as the source for your live site, create a Jira ticket to ask Infra to adjust the build process. From then on, changes you make to the trunk of this repository automatically update the live site.
Please let us know if you run into issues with the template.