Skip to content

Commit 55aecef

Browse files
Mikalai Radchukm1kola
authored andcommitted
Disables external link hash checks
HTML proofer produces false positives for links which contain hashes handled by JavaScript. This is very common for GitHub links where we link to a specific piece of code: e.g. `#L164-L180` for lines from 164 to 180 in a specific file. Pages like these do not have actual `<a href="#L164-L180">...</a>` elements and HTML proofer considers it to be an issue while these links are perfectly ok. Signed-off-by: Mikalai Radchuk <[email protected]>
1 parent 851badc commit 55aecef

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

content/en/docs/Concepts/olm-architecture/dependency-resolution/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ Note: `properties.yaml` is supported in `1.17.4+` versions of OPM.
7979

8080
## Declaring Dependencies
8181

82-
Required dependencies are statically defined in the operator bundle one of two ways:
82+
Required dependencies are statically defined in the operator bundle one of two ways:
8383
- `dependencies.yaml` file
8484
- `properties.yaml` file (supported by `1.17.4+ versions of OPM)
85-
85+
8686
Each of these files can be included in the `metadata` directory of the operator bundle. For more information on bundles and the their format, see the [bundle docs](https://github.com/operator-framework/operator-registry/blob/master/docs/design/operator-bundle.md).
8787

8888
Currently, these types of constraints are supported in the `dependencies.yaml` file:
@@ -502,7 +502,7 @@ Operators may add or remove APIs at any time - always specify an `olm.gvk` depen
502502

503503
### Set a minimum version
504504

505-
The Kubernetes [documentation on API changes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md#readme) describes what changes are allowed for kube-style operator APIs. These versioning conventions allow an operator to update an API without bumping the `apiVersion`, as long as the API is backwards-compatible.
505+
The Kubernetes [documentation on API changes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md) describes what changes are allowed for kube-style operator APIs. These versioning conventions allow an operator to update an API without bumping the `apiVersion`, as long as the API is backwards-compatible.
506506

507507
For operator dependencies, this means that knowing the `apiVersion` of a dependency may not be enough to ensure the dependent operator works as intended.
508508

hack/ci/link-check.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ CONTAINER_ENGINE=${CONTAINER_ENGINE:="docker"}
77
# ignore
88
# 1: links going back to help.github.com are rate-limited and can make this flaky
99
# 2: docsy autogenerated edit links to original markdown source, which will fail if the markdown file is new
10-
${CONTAINER_ENGINE} run --rm -v $(pwd)/public:/target mtlynch/htmlproofer /target --ignore-empty-alt --ignore-status-codes 429 --allow-hash-href --ignore-urls '/help.github.com/,/edit\/master\/.*\.md/,/tree\/master\/.*\.md/,/new\/master\/.*filename=change-me\.md/'
10+
${CONTAINER_ENGINE} run --rm -v $(pwd)/public:/target mtlynch/htmlproofer /target --ignore-empty-alt --ignore-status-codes 429 --allow-hash-href --no-check-external-hash --ignore-urls '/help.github.com/,/edit\/master\/.*\.md/,/tree\/master\/.*\.md/,/new\/master\/.*filename=change-me\.md/'

0 commit comments

Comments
 (0)