Просмотр исходного кода

fix: update dependencies in docs

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
Moritz Johner 2 лет назад
Родитель
Сommit
5963bc7702

+ 1 - 1
docs/api/clustersecretstore.md

@@ -6,7 +6,7 @@ The `ClusterSecretStore` is a cluster scoped SecretStore that can be referenced
 
 ## Example
 
-For a full list of supported fields see [spec](./spec.md) or dig into our [guides](../guides).
+For a full list of supported fields see [spec](./spec.md) or dig into our [guides](../guides/introduction.md).
 
 ``` yaml
 {% include 'full-cluster-secret-store.yaml' %}

+ 1 - 1
docs/guides/pushsecrets.md

@@ -37,5 +37,5 @@ By leaving off the secret key but setting the remote property option.
 
 This will _marshal_ the entire secret data and push it into this single property as a JSON object.
 
-!!! warning inline end
+!!! warning inline
     This should _ONLY_ be done if the secret data is marshal-able. Values like, binary data cannot be marshaled and will result in error or invalid secret data.

+ 3 - 3
docs/provider/yandex-certificate-manager.md

@@ -4,7 +4,7 @@ External Secrets Operator integrates with [Yandex Certificate Manager](https://c
 for secret management.
 
 ### Prerequisites
-* [External Secrets Operator installed](../guides-getting-started/#installing-with-helm)
+* [External Secrets Operator installed](../introduction/getting-started.md#installing-with-helm)
 * [Yandex.Cloud CLI installed](https://cloud.yandex.com/docs/cli/quickstart)
 
 ### Authentication
@@ -24,7 +24,7 @@ yc iam key create \
 ```bash
 kubectl create secret generic yc-auth --from-file=authorized-key=authorized-key.json
 ```
-* Create a [SecretStore](../api-secretstore/) pointing to `yc-auth` k8s secret:
+* Create a [SecretStore](../api/secretstore.md) pointing to `yc-auth` k8s secret:
 ```yaml
 apiVersion: external-secrets.io/v1beta1
 kind: SecretStore
@@ -58,7 +58,7 @@ Run the following command to ensure that the correct access binding has been add
 ```bash
 yc cm certificate list-access-bindings --id *****
 ```
-* Create an [ExternalSecret](../api-externalsecret/) pointing to `secret-store` and the certificate in Certificate Manager:
+* Create an [ExternalSecret](../api/externalsecret.md) pointing to `secret-store` and the certificate in Certificate Manager:
 ```yaml
 apiVersion: external-secrets.io/v1beta1
 kind: ExternalSecret

+ 3 - 3
docs/provider/yandex-lockbox.md

@@ -4,7 +4,7 @@ External Secrets Operator integrates with [Yandex Lockbox](https://cloud.yandex.
 for secret management.
 
 ### Prerequisites
-* [External Secrets Operator installed](../guides-getting-started/#installing-with-helm)
+* [External Secrets Operator installed](../introduction/getting-started.md#installing-with-helm)
 * [Yandex.Cloud CLI installed](https://cloud.yandex.com/docs/cli/quickstart)
 
 ### Authentication
@@ -24,7 +24,7 @@ yc iam key create \
 ```bash
 kubectl create secret generic yc-auth --from-file=authorized-key=authorized-key.json
 ```
-* Create a [SecretStore](../api-secretstore/) pointing to `yc-auth` k8s secret:
+* Create a [SecretStore](../api/secretstore.md) pointing to `yc-auth` k8s secret:
 ```yaml
 apiVersion: external-secrets.io/v1beta1
 kind: SecretStore
@@ -61,7 +61,7 @@ Run the following command to ensure that the correct access binding has been add
 ```bash
 yc lockbox secret list-access-bindings --name lockbox-secret
 ```
-* Create an [ExternalSecret](../api-externalsecret/) pointing to `secret-store` and `lockbox-secret`:
+* Create an [ExternalSecret](../api/externalsecret.md) pointing to `secret-store` and `lockbox-secret`:
 ```yaml
 apiVersion: external-secrets.io/v1beta1
 kind: ExternalSecret

+ 1 - 0
hack/api-docs/mkdocs.yml

@@ -77,6 +77,7 @@ nav:
       - Decoding Strategies: guides/decoding-strategy.md
       - Controller Classes: guides/controller-class.md
     - Generators: guides/generator.md
+    - Push Secrets: guides/pushsecrets.md
     - Operations:
       - Multi Tenancy: guides/multi-tenancy.md
       - Security Best Practices: guides/security-best-practices.md

+ 35 - 11
hack/api-docs/requirements.txt

@@ -1,18 +1,42 @@
-Click==8.0.3
+Babel==2.14.0
+certifi==2023.11.17
+charset-normalizer==3.3.2
+click==8.1.3
+colorama==0.4.6
+csscompressor==0.9.5
+ghp-import==2.1.0
 htmlmin==0.1.12
-Jinja2==3.0.3
+idna==3.6
+importlib-metadata==7.0.1
+importlib-resources==6.1.1
+Jinja2==3.1.2
 jsmin==3.0.1
 livereload==2.6.3
-Markdown==3.3.6
-MarkupSafe==2.0.1
-mkdocs==1.4.3
-mike @ git+https://github.com/jimporter/mike@300593c
-mkdocs-material==9.1.9
+Markdown==3.5.2
+MarkupSafe==2.1.1
+mergedeep==1.3.4
+mike @ git+https://github.com/jimporter/mike@300593c338b18f61f604d18457c351e166318020
+mkdocs==1.5.3
+mkdocs-macros-plugin==0.7.0
+mkdocs-material==9.5.3
+mkdocs-material-extensions==1.3.1
 mkdocs-minify-plugin==0.5.0
+packaging==23.2
+paginate==0.5.6
+pathspec==0.12.1
 pep562==1.1
-Pygments==2.15.1
-pymdown-extensions==9.11
-PyYAML==5.3.1 # 6.0 is broken: https://github.com/yaml/pyyaml/issues/601
+platformdirs==4.1.0
+Pygments==2.17.2
+pymdown-extensions==10.7
+python-dateutil==2.8.2
+PyYAML==5.3.1
+pyyaml_env_tag==0.1
+regex==2023.12.25
+requests==2.31.0
 six==1.16.0
+termcolor==2.4.0
 tornado==6.1
-mkdocs-macros-plugin==0.7.0
+urllib3==2.1.0
+verspec==0.1.0
+watchdog==3.0.0
+zipp==3.17.0