On Sun, 20 Apr 2025 at 12:04, sebb <seb...@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.
>

Yes, at the moment I'm generating and serving it locally. I'll see if I can
publish it on GitHub.


> > 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).
>
> Also, the cwiki content looks wrong: it should be the bare name of the
> project if that differs from the name of the wiki.
> Otherwise empty.
> It is used to link to the Attic project/ page.
>

OK, I'll fix that


> The project flag files are also different from current, which uses
> directory names rather than files.
> Changing that would require an update to the Puppet config, and a cutover
> plan.
>

ok


> > 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)
>

Yes, there is a convoluted process, but its painful and better avoided. Is
there a way to get them over HTTPS?
    https://attic.apache.org/flagged/cwiki/

If not, then hopefully an automated action that can publish them somewhere
- either Git or Svn

> 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.
>

Hopefully we won't need it. I'm just adding a "templates" feature that will
generate the JIRA text and email text for projects that are "In Progress"


> >
> > 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.
> (Or directory, in the case of project sites)
>
> > If so, the Lua filter is applied to the output.
>

OK, thanks - I'll fix that

Niall


> >
> > > Thanks
> > >
> > > Niall
>

Reply via email to