Skip to content

Conversation

niallkp
Copy link
Contributor

@niallkp niallkp commented Apr 29, 2025

Switch Attic to new Jekyll Generated Website

Replace the Anakia/Velocity build from XDOC with the Markdown/YAML based Jekyll/Ruby site generator using JustTheDocs theme.

Switching to Jekyll/Ruby brings many improvements from a tech PoV

  • no longer reliant on out-of-date technologies
  • access to many themes and plugins in the Jekyll Eco-system
  • better facilities for automated content generation
  • configurable JustTheDocs theme
  • switching from XML to YAML
  • better ability to manage/maintain the Attic Website
  • easier to add more features & improvements to Attic Website
  • automated ingestion of two external foundation JSON files

This has brought a number of important benefits:

  • better Looking Website
  • more up-to-date Theme & Navigation
  • Site Search
  • generation of Project related content from YAML files
  • automated generation of the Progress Tracking page (was manually maintained)
  • automated generation of the project list/navigation (was manually maintained)
  • automated generation of the Site & CWIKI banner deployment (were manually added)
  • ability to generate additional project lists such as Retired Projects page
  • improvements in the content on project pages (retirement & completion dates & links to board resolutions)
  • new project specific templates for creating JIRA & Email messages
  • reduced manual editing of the website during project retirement process

@niallkp niallkp changed the title Switch Switch Attic to new Jekyll Generated Website Apr 29, 2025
@niallkp niallkp requested review from hboutemy and sebbASF April 30, 2025 00:06
@niallkp niallkp self-assigned this Apr 30, 2025
@hboutemy
Copy link
Member

hboutemy commented Apr 30, 2025

looks pretty ok to me (with bdf1c5d small fix): once in the apache/attic main branch, the build should not fail: in the context of the PR, I'm even surprised the build is triggered, but happy it did not commit to actual asf-site and cwiki-retired branches, as it would have published the content

comparing the build output branches (asf-site and cwiki-retired branches) of current Velocity attic with Niall's content:

there is only one surprising change in cwiki-retired commit that would need investigation: see https://github.com/niallkp/attic/actions/runs/14747163631/job/41396600741

delete mode 100644 AAREADME.txt
 delete mode 100644 apex.txt
 delete mode 100644 tuscanyxdoc1x.txt
 delete mode 100644 tuscanyxdoc2x.txt

is the deletion of apex, tuscanyxdoc1x and tuscanyxdoc2x intentional?

@niallkp
Copy link
Contributor Author

niallkp commented Apr 30, 2025

there is only one surprising change in cwiki-retired commit that would need investigation: see https://github.com/niallkp/attic/actions/runs/14747163631/job/41396600741

delete mode 100644 AAREADME.txt
 delete mode 100644 apex.txt

The current Attic site is incorrect & Sebb changed the Apex setting in the new site to remove Apex, but hasn't fixed the current site - see:

delete mode 100644 tuscanyxdoc1x.txt
delete mode 100644 tuscanyxdoc2x.txt


is the deletion of apex, tuscanyxdoc1x and tuscanyxdoc2x intentional?

Yes. I believe those files are a mistake and the CWIKI spaces they block don't exist - so I never added them

@hboutemy
Copy link
Member

ok great: not bug but features :)
approving the PR: go go go...

Copy link
Member

@hboutemy hboutemy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@sebbASF sebbASF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK

@niallkp niallkp merged commit d27102b into apache:main Apr 30, 2025
1 check failed
@hboutemy
Copy link
Member

hboutemy commented May 1, 2025

Thank yu @niallkp: this is a great enhancement both for readers and for maintainers
which makes me hope for future contributors :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants