Skip to content

Commit

Permalink
Merge pull request #63 from simonbaird/custom-data-link-fixes
Browse files Browse the repository at this point in the history
Fix broken rule link in custom data documentation
  • Loading branch information
simonbaird authored Oct 17, 2023
2 parents 7aee0e4 + 624103a commit 5b53908
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
9 changes: 6 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@

#----------------------------------------------------------------------------
# Build a preview of the docs published at https://enterprise-contract.github.io/
# Build a preview of the docs published at https://enterprisecontract.dev/docs/
# including the current changes in this local repo.
#
# Fixme maybe: Unfortunately the docs built using this method have broken
# stylesheet links when viewed with a local file:// url.
#
# Usage:
# make ec-docs-preview
#
# See also the hack/local-build.sh script in the
# enterprise-contract.github.io repo which does something similar
# See also the Makefile in the enterprise-contract.github.io repo which has
# similar scripts for doing local docs preview builds.
#
HACBS_DOCS_DIR=../enterprise-contract.github.io/antora
HACBS_DOCS_REPO[email protected]:enterprise-contract/enterprise-contract.github.io.git
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/custom-data.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ level success value is `true`.

Notice the configuration currenly specifies the `minimal` collection. This means there
are a subset of the rules being applied. You can see the list of rules in the
link:https://enterprise-contract.github.io/ec-policies/release_policy.html#_available_rule_collections[documentation here].
link:https://enterprisecontract.dev/docs/ec-policies/release_policy.html#_available_rule_collections[documentation here].

You can also use ec to produce a list of the rules like this:

Expand Down Expand Up @@ -229,7 +229,7 @@ will provide a namespace later.

At the beginning of this document, you logged in on a member cluster. This is, currently, required in
order to access the default
link:https://enterprise-contract.github.io/ecc/main/reference.html#k8s-api-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicy[EnterpriseContractPolicy]
link:https://enterprisecontract.dev/docs/ecc/main/reference.html#k8s-api-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicy[EnterpriseContractPolicy]
and the public key. However, resources on the
cluster cannot be created this way. They must be created via the proxy. To do so, obtain a token from
https://registration-service-toolchain-host-operator.apps.stone-prd-host1.wdlc.p1.openshiftapps.com/[here]
Expand Down Expand Up @@ -268,10 +268,10 @@ This is the kind of thing that a RHTAP user might want to do based on what
security policies they decide are appopriate for their situation.

First, let's take a look at how that rule works. The documentation is
link:https://enterprise-contract.github.io/ec-policies/release_policy.html#step_image_registries__disallowed_task_step_image[here].
link:https://enterprisecontract.dev/docs/ec-policies/release_policy.html#step_image_registries__task_step_images_permitted[here].

Clicking through to
link:https://github.com/enterprise-contract/ec-policies/blob/main/policy/release/step_image_registries.rego#L32[the
link:https://github.com/enterprise-contract/ec-policies/blob/main/policy/release/step_image_registries.rego#L33[the
code] we can see a reference to `allowed_step_image_registry_prefixes`. This refers to some data that
comes from the `data` source.

Expand Down

0 comments on commit 5b53908

Please sign in to comment.