On Sun, 20 Apr 2025 at 17:51, Niall Pemberton <niall.pember...@gmail.com>
wrote:

>
>
> On Sun, 20 Apr 2025 at 09:44, sebb <seb...@gmail.com> wrote:
>
>> On Sun, 20 Apr 2025 at 01:10, Niall Pemberton <niall.pember...@gmail.com>
>> wrote:
>> >
>> > Hi,
>> >
>> > I have created a PoC to move the current Attic site generation from
>> XDOC &
>> > Forrest to Markdown & Jekyll:
>> >   https://github.com/niallkp/attic-jekyll-site
>> >
>> > Each project has a YAML file with details about it and its retirement
>> and
>> > that drives everything:
>> >   - generates a project page
>> >   - updates the Process Tracking Page
>> >   - updates the menu/list of projects in the Attic
>> >   - Generates the "flag" files for the Attic Banner on the site & Wiki
>> >
>> > At the moment it is pretty much functionally complete, but I've put a
>> TODO
>> > list in the README.md or the project:
>> >    https://github.com/niallkp/attic-jekyll-site/blob/main/README.md
>> >
>> > Thoughts/feedback welcome
>>
>> Looks good, and could be worth pursuing, but there are some missing
>> features that are essential for a full evaluation.
>>
>> There needs to be an action to generate the output so it can be checked.
>> Ideally so the site can be viewed directly.
>>
>
> I have manually published the generated site here for now, so you can have
> a look:
>     https://niallkp.github.io/
>

There were no "In Progress" projects (i.e. project's whose move to Attic is
not complete), so I've just added the data files for Gora & Mnemonic.

The main bits of the site are generated from the project data files. Just
to highlight a few of the generated pages:
  - The Tracking page: https://niallkp.github.io/tracking.html
  - Project Pages e.g. Gora https://niallkp.github.io/projects/gora.html
  - The list of projects on each page
  - The site flag files are generated in "/flagged/site": e.g.
https://niallkp.github.io/flagged/site/any23.txt
  - The cwiki flag files are generated in "/flagged/site": e.g.
https://niallkp.github.io/flagged/cwiki/mnemonic.txt

Projects that are "in progress" also have a link to a "templates" page, so
for example, here is Gora's Template page:
   - https://niallkp.github.io/templates/gora.html
The "template" page has text for creating the JIRA and sending out the user
& announcement emails.

Obviously the "Look & Feel" is crap. Its using the default "Minima" theme
from Jekyll. We can chose a different theme or try to re-create the L&F of
the existing site

Niall



>
> Niall
>
>
>
>>
>> It looks like the CWKI flags are generated as part of the website.
>> However, the Confluence webserver host does not have access to the
>> Attic website (unlike the TLP server, which hosts Attic as well as the
>> retired sites).
>>
>> I don't think it makes sense to checkout the entire Attic website on
>> the Confluence server merely to get access to the flag files.
>> Probably need to use a separate GHA to generate the required files in
>> a separate branch.
>> (AFAICT,  Git does not support checkout of a sub-directory, at least
>> not in a way that can be used by Puppet config)
>>
>> There are some Python scripts in the existing codebase that need to be
>> converted to use the new format.
>> Probably only retire.py needs significant work.
>>
>> Minor nit: the plugin files say that the flagged files are used by a
>> Lua filter to decide whether to add the banner.
>> That is not the case; the httpd config extracts the project name from
>> the request, and checks to see if there is a flag file with that name.
>> If so, the Lua filter is applied to the output.
>>
>> > Thanks
>> >
>> > Niall
>>
>

Reply via email to