Create applications-components directory #532
Conversation
Create an "Applications & Components" sub-directory under the "Building" directory and move the relevant pages under it. Signed-off-by: Tomáš Nevrlka <[email protected]>
New applications-components directory was created with the following pages: - creating.adoc - deleting.adoc - configuration-as-code.adoc - component-nudges.adoc Fix references to them Signed-off-by: Tomáš Nevrlka <[email protected]>
tnevrlka
requested review from
a team,
arewm,
ccronca,
ralphbean and
sfowl
as code owners
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
🚀 Preview is available at: https://pr-532--konflux-docs.netlify.app |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively reorganizes the documentation by creating a new "Applications & Components" subdirectory and moving relevant pages into it. The changes improve the structure and navigability of the user docs. The cross-references have been updated across multiple files to reflect the new file locations.
My review includes a critical fix for a broken link that resulted from the file move and a suggestion to improve consistency in cross-reference formatting for better long-term maintainability. Overall, this is a good structural improvement for the documentation.
| [NOTE] | ||
| ==== | ||
| By default, {ProductName} only looks for image digest references in Dockerfiles, Containerfiles, and YAML files. However, you can xref:./customizing-the-build.adoc[customize your build pipeline] to adjust that list of files with an annotation on the push PipelineRun definition. This annotation supports a comma-separated list of link:https://docs.renovatebot.com/string-pattern-matching/[regex or glob patterns]. The following annotation would replicate the default behavior. | ||
| By default, {ProductName} only looks for image digest references in Dockerfiles, Containerfiles, and YAML files. However, you can xref:customizing-the-build.adoc[customize your build pipeline] to adjust that list of files with an annotation on the push PipelineRun definition. This annotation supports a comma-separated list of link:https://docs.renovatebot.com/string-pattern-matching/[regex or glob patterns]. The following annotation would replicate the default behavior. |
There was a problem hiding this comment.
The cross-reference to customizing-the-build.adoc is broken. When this file was moved to the applications-components subdirectory, the relative path to customizing-the-build.adoc changed. The current xref:customizing-the-build.adoc[...] will not resolve correctly.
To fix this and improve maintainability, I recommend using the full Antora resource ID, which is more robust against file relocations.
By default, {ProductName} only looks for image digest references in Dockerfiles, Containerfiles, and YAML files. However, you can xref:building:customizing-the-build.adoc[customize your build pipeline] to adjust that list of files with an annotation on the push PipelineRun definition. This annotation supports a comma-separated list of link:https://docs.renovatebot.com/string-pattern-matching/[regex or glob patterns]. The following annotation would replicate the default behavior.
| == Theory | ||
|
|
||
| The fundamental process involves creating a Containerfile to encapsulate your binary build process, similar to the production of container images. This allows you to define applications and components in {ProductName} as you xref:creating.adoc[normally would]. | ||
| The fundamental process involves creating a Containerfile to encapsulate your binary build process, similar to the production of container images. This allows you to define applications and components in {ProductName} as you xref:applications-components/creating.adoc[normally would]. |
There was a problem hiding this comment.
For consistency and improved maintainability, it's better to use the full Antora resource ID for cross-references, like xref:module:page.adoc[...]. While the relative path xref:applications-components/creating.adoc[...] works here, using the full path xref:building:applications-components/creating.adoc[...] is more robust against future file moves and is consistent with how xrefs are updated in other files in this pull request.
The fundamental process involves creating a Containerfile to encapsulate your binary build process, similar to the production of container images. This allows you to define applications and components in {ProductName} as you xref:building:applications-components/creating.adoc[normally would].
1 participant
There are a lot of pages inside the "Building" section of the user docs that correspond to many different aspects of build pipelines in Konflux. Categorizing these pages into further sections will make it easier and faster for users to find the documentation they need.
Create an "Applications & Components" sub-directory under the "Building" directory in the nav doc, and move the following pages under it:
Closes #528