Răsfoiți Sursa

Deployed 93d47712 to main with MkDocs 1.2.3 and mike 1.1.2

Docs 4 ani în urmă
părinte
comite
33e5af7d34

+ 3 - 2
main/contributing-devguide/index.html

@@ -1477,6 +1477,7 @@ then clone the repo:</p>
 <div class="highlight"><pre><span></span><code>git clone https://github.com/external-secrets/external-secrets.git
 <div class="highlight"><pre><span></span><code>git clone https://github.com/external-secrets/external-secrets.git
 <span class="nb">cd</span> external-secrets
 <span class="nb">cd</span> external-secrets
 </code></pre></div>
 </code></pre></div>
+<p><em>Note: many of the <code>make</code> commands use <a href="https://github.com/mikefarah/yq">yq</a>, version 4.2X.X or higher.</em></p>
 <p>If you want to run controller tests you also need to install kubebuilder's <code>envtest</code>.</p>
 <p>If you want to run controller tests you also need to install kubebuilder's <code>envtest</code>.</p>
 <p>The recommended way to do so is to install <a href="https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest">setup-envtest</a></p>
 <p>The recommended way to do so is to install <a href="https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest">setup-envtest</a></p>
 <p>Here is an example on how to set it up:</p>
 <p>Here is an example on how to set it up:</p>
@@ -1545,11 +1546,11 @@ helm upgrade --install external-secrets ./deploy/charts/external-secrets/ --set
 <p>We use <a href="https://squidfunk.github.io/mkdocs-material/">mkdocs material</a> and <a href="https://github.com/jimporter/mike">mike</a> to generate this
 <p>We use <a href="https://squidfunk.github.io/mkdocs-material/">mkdocs material</a> and <a href="https://github.com/jimporter/mike">mike</a> to generate this
 documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
 documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
 <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
 <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
-<div class="highlight"><pre><span></span><code>make serve-docs
+<div class="highlight"><pre><span></span><code>make docs.serve
 </code></pre></div>
 </code></pre></div>
 <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
 <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
 <div class="highlight"><pre><span></span><code>make docs
 <div class="highlight"><pre><span></span><code>make docs
-make serve-docs
+make docs.serve
 </code></pre></div>
 </code></pre></div>
 <p>Open <code>http://localhost:8000</code> in your browser.</p>
 <p>Open <code>http://localhost:8000</code> in your browser.</p>
 <p>Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local <code>gh-pages</code> branch.</p>
 <p>Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local <code>gh-pages</code> branch.</p>

+ 1 - 1
main/contributing-process/index.html

@@ -1613,7 +1613,7 @@ run managed tests.</p>
 They create real infrastructure at a cloud provider and deploy the controller
 They create real infrastructure at a cloud provider and deploy the controller
 into that environment.
 into that environment.
 This is necessary to test the authentication integration
 This is necessary to test the authentication integration
-(<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Worklaod Identity</a>,
+(<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Workload Identity</a>,
 <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
 <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
 <p>These tests are time intensive (~20-45min) and must be triggered manually by
 <p>These tests are time intensive (~20-45min) and must be triggered manually by
 a maintainer when a particular provider or authentication mechanism was changed:</p>
 a maintainer when a particular provider or authentication mechanism was changed:</p>

Fișier diff suprimat deoarece este prea mare
+ 0 - 0
main/search/search_index.json


BIN
main/sitemap.xml.gz


Fișier diff suprimat deoarece este prea mare
+ 600 - 77
main/spec/index.html


Unele fișiere nu au fost afișate deoarece prea multe fișiere au fost modificate în acest diff