Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure that xref is used to refence doc #219

Merged
merged 1 commit into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ deploy.json
# Vale styles
.vale/styles/*
!.vale/styles/config
!.vale/styles/Konflux
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Vocab = konflux

[*.adoc]

BasedOnStyles = RedHat
BasedOnStyles = RedHat, Konflux
9 changes: 9 additions & 0 deletions .vale/styles/Konflux/UpstreamLinks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: Replace URL of upstream doc '%s' with 'xref:ROOT:relative/path/to/upstream/file.adoc'.
level: error
ignorecase: true
nonword: true
scope: raw
tokens:
- 'https:\/\/konflux-ci\.dev\/docs\/[-_\w/]+'

Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:

[IMPORTANT]
====
* Hermetic builds disable network access, so a build with dependencies outside of its Git repository--including supported languages--might fail. To prevent this, or to pull in dependencies from a package manager for one of the xref:how-tos/configuring/prefetching-dependencies.adoc#supported-languages[supported languages], follow the instructions in link:https://konflux-ci.dev/docs/how-tos/configuring/prefetching-dependencies/[Prefetching the package manager dependencies for the hermetic build].
* Hermetic builds disable network access, so a build with dependencies outside of its Git repository--including supported languages--might fail. To prevent this, or to pull in dependencies from a package manager for one of the xref:how-tos/configuring/prefetching-dependencies.adoc#supported-languages[supported languages], follow the instructions in xref:ROOT:how-tos/configuring/prefetching-dependencies.adoc[Prefetching the package manager dependencies for the hermetic build].
+
Similarly, with a link:https://github.com/konflux-ci/build-definitions/blob/main/task/buildah/0.1/buildah.yaml[Buildah] task for a non-Java application, when you set the `*hermetic*` parameter to `true`, you’re isolating the build from the network, which restricts it to building only from dependencies listed in your Git repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ integration tests manually in xref:how-tos/testing/integration/rerunning.adoc[Re
NOTE: When multiple contexts are defined, the IntegrationTestScenario will execute if any of the specified contexts match the snapshot. This approach ensures that the test runs as long as at least one context applies, without requiring all defined contexts to be met.

.Prerequisites
- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer link:https://konflux-ci.dev/docs/getting-started/cli/[Getting started with the CLI].
- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer xref:ROOT:getting-started/cli.adoc[Getting started with the CLI].

.Procedure

Expand Down
Loading