search

konflux-ci / docs

This repository is the official source of record for upstream Konflux documentation.
https://konflux-ci.dev/docs/
4 stars 37 forks source link

document bundle metadata format troubleshooting #121

Closed grokspawn closed 3 weeks ago

grokspawn commented 3 weeks ago

Documenting troubleshooting for the new bundle metadata policy enforcement, aligned with target OCP versions.

The intent is to use this doc as a reference that we'll cite as part of the failure messaging related to the policy task (https://github.com/konflux-ci/build-definitions/pull/1327).

grokspawn commented 3 weeks ago

As I mentioned in konflux-ci/build-definitions#1327 (comment), can we move this to a TROUBELSHOOTHING.md file in the task directory within build-definitions? We can then link directly to the build-definitions repo troubleshooting as needed from the task.

I'm clear on transplanting all of this to a TROUBLESHOOTING.md file that is co-resident with the task definitions. I'm not clear on what kind of reference you would like here? Or if there would be any. One reading of your last sentence would be to close/abandon this PR and embed all the docs/references in the task area.

Can you clarify, @arewm ?

arewm commented 3 weeks ago

I don't think that we need any references in this document. We need to work to merge the task documentation, usage, and troubleshooting into the rendered konflux-ci documentation. When we do that, we should get anything added there for "free."

grokspawn commented 3 weeks ago

Thanks for the detail. Abandoning this for all content in build-definitions. (PR).