Try adding an index of build tasks

[ralphbean]

This is based on https://github.com/konflux-ci/build-definitions/pull/1381

Related: https://issues.redhat.com/browse/KONFLUX-1229

[ralphbean]

I'm posting this here (prematurely) just to see what it looks like in the PR preview build.

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[ralphbean]

Well, that's something: https://pr-129--konflux-docs.netlify.app/tasks/

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[github-actions[bot]]

🚀 Preview is available at https://pr-129--konflux-docs.netlify.app

[zregvart]

The EC team had used an Antora extension that provided the deserialized Task object to a Handlebars template for the Task page and for the navigation. This has the benefit of pointing to the YAML Task files and generating the documentation from them.

We decided that a better approach would be to generate the Asciidoc files at build time, and mandate that they're committed in git. We decided not to write shell scripts for the templating.

The drawback of the approach taken here is that it ties the layout/content of build-definitions repository to the docs repository here and with that a change in the build-definitions could cause the documentation not to build or build incorrectly. I think the approach of having the Asciidoc files in the build-definitions repository could be something that we consider.

[ralphbean]

Ack. I am uncertain what's going to happen with antora here w.r.t. @MartinBasti's ongoing investigation. Maybe we should put this on hold until that settles; then, revisit here.

[arewm]

I just added some of the descriptions to the pipelines in build-definitions: https://github.com/konflux-ci/build-definitions/pull/1397

Would you be able to lay out a similar process for generating those instead of my manual list that I also just introduced: https://konflux-ci.dev/docs/advanced-how-tos/installing/enabling-builds/#available-pipelines

[ralphbean]

Yes, but - let's hold off for the moment until we get an update about the direction from Martin.

[MartinBasti]

I don't have updates, we may have discussion about it next week. So far it will be much harder to use Markdown than Antora+Adoc for our usecases

[ralphbean]

Related prior work: https://github.com/konflux-ci/build-definitions/pull/756