From c53b7b75b8661c16215f3c446012d460ef561896 Mon Sep 17 00:00:00 2001 From: Simon Baird Date: Thu, 3 Oct 2024 17:54:37 -0400 Subject: [PATCH 1/2] Switch to "unversioned" in the antora config There will be an impact on the urls. I'll aim to check for broken links later and maybe try to set up a redirect. See also: https://docs.antora.org/antora/latest/component-with-no-version/ https://issues.redhat.com/browse/EC-903 Ref: https://issues.redhat.com/browse/EC-86 --- docs/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 78c400932..67bca0208 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -17,6 +17,6 @@ --- name: ec-cli title: Enterprise Contract CLI -version: main +version: ~ nav: - modules/ROOT/nav.adoc From 79d1fc4dac859bb7d9feb4f76ceb590adaa0c457 Mon Sep 17 00:00:00 2001 From: Simon Baird Date: Fri, 4 Oct 2024 14:50:13 -0400 Subject: [PATCH 2/2] Update links for unversioned antora components The /main/ url path segment will be gone, so update some links accordingly. Ref: https://issues.redhat.com/browse/EC-86 --- README.md | 2 +- tasks/verify-enterprise-contract/0.1/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c31099824..5001c96f9 100644 --- a/README.md +++ b/README.md @@ -52,4 +52,4 @@ $ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo [pol]: https://github.com/enterprise-contract/ec-policies/ -[docs]: https://enterprisecontract.dev/docs/ec-cli/main/ec.html +[docs]: https://enterprisecontract.dev/docs/ec-cli/ec.html diff --git a/tasks/verify-enterprise-contract/0.1/README.md b/tasks/verify-enterprise-contract/0.1/README.md index d683106a5..28fdb20dc 100644 --- a/tasks/verify-enterprise-contract/0.1/README.md +++ b/tasks/verify-enterprise-contract/0.1/README.md @@ -10,7 +10,7 @@ kubectl apply -f https://raw.githubusercontent.com/enterprise-contract/ec-cli/ma * **IMAGES**: A JSON formatted list of images. ### Optional * **POLICY_CONFIGURATION**: Name or inline policy in JSON configuration to use. For name `namespace/name` or `name` syntax supported. If - namespace is omitted the namespace where the task runs is used. For inline policy provide the [specification](https://enterprise-contract.github.io/ecc/main/reference.html#k8s-api-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicyspec) as JSON. + namespace is omitted the namespace where the task runs is used. For inline policy provide the [specification](https://enterprisecontract.dev/docs/ecc/reference.html#k8s-api-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicyspec) as JSON. * **PUBLIC_KEY**: Public key used to verify signatures. Must be a valid k8s cosign reference, e.g. k8s://my-space/my-secret where my-secret contains the expected cosign.pub attribute. @@ -27,7 +27,7 @@ kubectl apply -f https://raw.githubusercontent.com/enterprise-contract/ec-cli/ma ## Usage -This TaskRun runs the Task to verify an image. This assumes a policy is created and stored on the cluster with hte namespaced name of `enterprise-contract-service/default`. For more information on creating a policy, refer to the Enterprise Contract [documentation](https://enterprise-contract.github.io/ecc/main/index.html). +This TaskRun runs the Task to verify an image. This assumes a policy is created and stored on the cluster with hte namespaced name of `enterprise-contract-service/default`. For more information on creating a policy, refer to the Enterprise Contract [documentation](https://enterprisecontract.dev/docs/ecc/index.html). ```yaml apiVersion: tekton.dev/v1