From 31a7e3cf2703d139fd617e65e78cfb0d543a6523 Mon Sep 17 00:00:00 2001 From: Ashley Davis Date: Fri, 20 Jan 2023 14:42:01 +0000 Subject: [PATCH 1/5] don't copy other reference files over to docs/ this was safe previously, but we added more files to reference which means that `docs/` always gets clobbered by whatever's been created for the latest version Signed-off-by: Ashley Davis --- scripts/gendocs/generate-new-import-path-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/gendocs/generate-new-import-path-docs b/scripts/gendocs/generate-new-import-path-docs index da0e44681d1..d7b19b05312 100755 --- a/scripts/gendocs/generate-new-import-path-docs +++ b/scripts/gendocs/generate-new-import-path-docs @@ -168,6 +168,6 @@ genversionwithcli "release-1.11" "$LATEST_VERSION" # Rather than generate the same docs again for /docs, copy from the latest version cp -r "${REPO_ROOT}/content/${LATEST_VERSION}/cli" "${REPO_ROOT}/content/docs/" -cp -r "${REPO_ROOT}/content/${LATEST_VERSION}/reference" "${REPO_ROOT}/content/docs/" +cp "${REPO_ROOT}/content/${LATEST_VERSION}/reference/api-docs.md" "${REPO_ROOT}/content/docs/reference/" echo "Generated reference documentation for cert-manager versions with the github.com/cert-manager/cert-manager import path" From e0acd6ddb561d413424633aa870e953758b04ddc Mon Sep 17 00:00:00 2001 From: Ashley Davis Date: Fri, 20 Jan 2023 14:58:17 +0000 Subject: [PATCH 2/5] 'backport' cmctl links fixes to v1.11-docs Signed-off-by: Ashley Davis --- content/v1.11-docs/reference/cmctl.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/v1.11-docs/reference/cmctl.md b/content/v1.11-docs/reference/cmctl.md index 09c8c6384d6..095c9dfe6e0 100644 --- a/content/v1.11-docs/reference/cmctl.md +++ b/content/v1.11-docs/reference/cmctl.md @@ -226,9 +226,9 @@ of these commands are subject to change or removal in future releases. Sub-commands are available to create different resources: ##### CertificateSigningRequest -To create a [CertificateSigningRequest](./kube-csr.md), use +To create a [CertificateSigningRequest](../usage/kube-csr.md), use ```console -cmctl x create csr` +cmctl x create csr ``` This command takes the name of the CertificateSigningRequest to be created, as well as a file containing a Certificate manifest (`-f, @@ -269,7 +269,7 @@ cmctl x install ``` This command makes sure that the required `CustomResourceDefinitions` are installed together with the cert-manager, cainjector and webhook components. -Under the hood, a procedure similar to the [Helm install procedure](../install/helm.md#steps) is used. +Under the hood, a procedure similar to the [Helm install procedure](../installation/helm.md#steps) is used. You can also use `cmctl x install` to customize the installation of cert-manager. @@ -282,7 +282,7 @@ cmctl x install \ ``` You can find [a full list of the install parameters on cert-manager's ArtifactHub page](https://artifacthub.io/packages/helm/cert-manager/cert-manager#configuration). These are the same parameters that are available when using the Helm chart. -Once you have deployed cert-manager, you can [verify](../install/verify.md) the installation. +Once you have deployed cert-manager, you can [verify](../installation/verify.md) the installation. The CLI also allows the user to output the templated manifest to `stdout`, instead of installing the manifest on the cluster. From e3c355cc93715f8f667b32636797490b01a95139 Mon Sep 17 00:00:00 2001 From: Ashley Davis Date: Fri, 20 Jan 2023 17:50:54 +0000 Subject: [PATCH 3/5] fix invalid HTML in sidebar when a Dropdown element was embedded in another Dropdown element, a
tag would appear as a direct descendent of a
    which is invalid (since only
  • are allowed to appear in
      ) this change embeds the dropdown in an
    • which seems to work fine in testing and fixes the invalid HTML Signed-off-by: Ashley Davis --- components/docs/Sidebar/Dropdown.jsx | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/components/docs/Sidebar/Dropdown.jsx b/components/docs/Sidebar/Dropdown.jsx index 63aa2ef1b16..b57ae2d39fe 100644 --- a/components/docs/Sidebar/Dropdown.jsx +++ b/components/docs/Sidebar/Dropdown.jsx @@ -36,12 +36,14 @@ export default function Dropdown({ {routes.routes.map((r, idx) => { if (!r.path) { return ( - +
    • + +
      • ) } else { return ( From 4dc2b5391dfd3050b1cadace9eec7d3c1e6862cd Mon Sep 17 00:00:00 2001 From: Ashley Davis Date: Fri, 20 Jan 2023 17:55:13 +0000 Subject: [PATCH 4/5] fix invalid HTML in version selector Listbox (see https://headlessui.com/react/listbox) provides certain form elements for use, which get translated into normal HTML elements it's illegal for a