Try adding an index of build tasks #129
Conversation
|
I'm posting this here (prematurely) just to see what it looks like in the PR preview build. |
ralphbean
force-pushed
the
task-index
branch
from
94d857a
to
3efa50e
Compare
ralphbean
force-pushed
the
task-index
branch
from
e430f92
to
abcf990
Compare
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
Well, that's something: https://pr-129--konflux-docs.netlify.app/tasks/ |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-129--konflux-docs.netlify.app |
|
|
||
| [[buildah-remote-oci-ta-0.2]]buildah-remote-oci-ta (0.2):: Buildah task builds source code into a container image and pushes the image into container registry using buildah tool. See also: https://github.com/konflux-ci/build-definitions/tree/main/task/buildah-remote-oci-ta/0.2/README.md[README.md] https://github.com/konflux-ci/build-definitions/tree/main/task/buildah-remote-oci-ta/0.2/MIGRATION.md[MIGRATION.md] | ||
|
|
||
| [[buildah-rhtap-0.1]]buildah-rhtap (0.1):: Buildah task builds source code into a container image and pushes the image into container registry using buildah tool. See also: |
There was a problem hiding this comment.
Did we decide that we will not filter the list of tasks to remove ones like this?
There was a problem hiding this comment.
Good catch! Let's filter it.
|
|
||
| [[buildah-remote-oci-ta-0.2]]buildah-remote-oci-ta (0.2):: Buildah task builds source code into a container image and pushes the image into container registry using buildah tool. See also: https://github.com/konflux-ci/build-definitions/tree/main/task/buildah-remote-oci-ta/0.2/README.md[README.md] https://github.com/konflux-ci/build-definitions/tree/main/task/buildah-remote-oci-ta/0.2/MIGRATION.md[MIGRATION.md] | ||
|
|
||
| [[buildah-rhtap-0.1]]buildah-rhtap (0.1):: Buildah task builds source code into a container image and pushes the image into container registry using buildah tool. See also: |
There was a problem hiding this comment.
See also: is printed even though there is nothing to see.
|
|
||
| [[update-infra-deployments-0.1]]update-infra-deployments (0.1):: Clones redhat-appstudio/infra-deployments repository, runs script in 'SCRIPT' parameter, generates pull-request for redhat-appstudio/infra-deployments repository. See also: https://github.com/konflux-ci/build-definitions/tree/main/task/update-infra-deployments/0.1/README.md[README.md] | ||
|
|
||
| [[upload-sbom-to-trustification-0.1]]upload-sbom-to-trustification (0.1):: Upload an SBOM file to [Trustification] using the [BOMbastic] API. See also: https://github.com/konflux-ci/build-definitions/tree/main/task/upload-sbom-to-trustification/0.1/README.md[README.md] |
There was a problem hiding this comment.
The [Trustification] and [BOMbastic] references are hyperlinks in the README but are not rendered properly here.
|
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. |
|
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. |
|
I just added some of the descriptions to the pipelines in build-definitions: konflux-ci/build-definitions#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 |
|
Yes, but - let's hold off for the moment until we get an update about the direction from Martin. |
|
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 |
|
Related prior work: konflux-ci/build-definitions#756 |
This is based on konflux-ci/build-definitions#1381
Related: https://issues.redhat.com/browse/KONFLUX-1229