Skip to content

Commit

Permalink
Publish new documentation for version 0.88.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Automated CI committed Nov 27, 2024
1 parent 78cc5a1 commit 4f9884d
Show file tree
Hide file tree
Showing 24 changed files with 316 additions and 264 deletions.
42 changes: 0 additions & 42 deletions analyzer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,48 +642,6 @@
<a href="/cli/agents/">Agents</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/agents/get-agents/" class="dd-item">
<div>
<a href="/cli/agents/get-agents/">
Get Agents
</a>
</div>
</li>
<li data-nav-id="/cli/agents/create-agent/" class="dd-item">
<div>
<a href="/cli/agents/create-agent/">
Create Agent
</a>
</div>
</li>
<li data-nav-id="/cli/agents/delete-agent/" class="dd-item">
<div>
<a href="/cli/agents/delete-agent/">
Delete Agent
</a>
</div>
</li>
<li data-nav-id="/cli/agents/patch-agent/" class="dd-item">
<div>
<a href="/cli/agents/patch-agent/">
Patch Agent
</a>
</div>
</li>
<li data-nav-id="/cli/agents/install/" class="dd-item">
<div>
<a href="/cli/agents/install/">
Install
</a>
</div>
</li>
<li data-nav-id="/cli/agents/uninstall/" class="dd-item">
<div>
<a href="/cli/agents/uninstall/">
Uninstall
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/analyzer/" class="dd-item parent active haschildren
Expand Down
21 changes: 0 additions & 21 deletions app-proxy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -707,27 +707,6 @@
<a href="/cli/annotations/">Annotations</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/annotations/get/" class="dd-item">
<div>
<a href="/cli/annotations/get/">
get
</a>
</div>
</li>
<li data-nav-id="/cli/annotations/create/" class="dd-item">
<div>
<a href="/cli/annotations/create/">
create
</a>
</div>
</li>
<li data-nav-id="/cli/annotations/delete/" class="dd-item">
<div>
<a href="/cli/annotations/delete/">
delete
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/app-proxy/" class="dd-item parent active haschildren
Expand Down
2 changes: 1 addition & 1 deletion audit/download/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1840,7 +1840,7 @@ <h3 id="options">Options</h3>
<td>--file</td>
<td></td>
<td>string</td>
<td>/codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv</td>
<td>/codefresh/volume/cli/codefresh_audit_2024-11-27_14-25-06.csv</td>
<td>The name of the file and the directory in which the audit will be saved</td>
</tr>
</tbody>
Expand Down
7 changes: 0 additions & 7 deletions board/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -765,13 +765,6 @@
<a href="/cli/audit/">Audit</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/audit/download/" class="dd-item">
<div>
<a href="/cli/audit/download/">
Download
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/board/" class="dd-item parent active haschildren
Expand Down
20 changes: 3 additions & 17 deletions clusters/create-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -825,24 +825,10 @@
<i class="fa fa-angle-down fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/clusters/get-clusters/" class="dd-item">
<div>
<a href="/cli/clusters/get-clusters/">
Get Clusters
</a>
</div>
</li>
<li data-nav-id="/cli/clusters/delete-cluster/" class="dd-item">
<div>
<a href="/cli/clusters/delete-cluster/">
Delete Cluster
</a>
</div>
</li>
<li data-nav-id="/cli/clusters/create-cluster/" class="dd-item active">
<li data-nav-id="/cli/runner-resources/runner/" class="dd-item">
<div>
<a href="/cli/clusters/create-cluster/">
Create Cluster
<a href="/cli/runner-resources/runner/">
Runner
</a>
</div>
</li>
Expand Down
7 changes: 0 additions & 7 deletions clusters/delete-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,6 @@
<a href="/cli/completion/">Completion</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/completion/codefresh-completion/" class="dd-item">
<div>
<a href="/cli/completion/codefresh-completion/">
Codefresh Completion
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/authentication/" class="dd-item haschildren
Expand Down
7 changes: 7 additions & 0 deletions components/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -853,6 +853,13 @@
<a href="/cli/codefresh-cli-components/">Codefresh CLI components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/codefresh-cli-components/components/" class="dd-item">
<div>
<a href="/cli/codefresh-cli-components/components/">
components
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/components/" class="dd-item parent active haschildren
Expand Down
7 changes: 7 additions & 0 deletions compositions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1313,6 +1313,13 @@
<a href="/cli/validation/">Validation</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/validation/validate-pipeline-yaml/" class="dd-item">
<div>
<a href="/cli/validation/validate-pipeline-yaml/">
Validate pipeline yaml
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/workflow-data/" class="dd-item haschildren
Expand Down
18 changes: 9 additions & 9 deletions contexts/create-context/create-git-context/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1688,8 +1688,8 @@
<ul>
<li><a href="#bitbucket-bitbucket"><a href="bitbucket">bitbucket</a></a></li>
<li><a href="#github-github"><a href="github">github</a></a></li>
<li><a href="#gitlab-gitlab"><a href="gitlab">gitlab</a></a></li>
<li><a href="#stash-stash"><a href="stash">stash</a></a></li>
<li><a href="#gitlab-gitlab"><a href="gitlab">gitlab</a></a></li>
</ul></li>
</ul></li>
</ul>
Expand Down Expand Up @@ -1730,14 +1730,6 @@ <h3 id="github-github"><a href="github">github</a></h3>

<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create Github context you need to generate the token here: <a href="https://github.com/settings/tokens">https://github.com/settings/tokens</a>.</p>

<h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>

<p><code>codefresh create context git gitlab &lt;name&gt;</code></p>

<p>Create a gitlab context.</p>

<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create gitlab context you need to generate the token here: <a href="https://gitlab.com/profile/personal_access_tokens">https://gitlab.com/profile/personal_access_tokens</a>.</p>

<h3 id="stash-stash"><a href="stash">stash</a></h3>

<p><code>codefresh create context git stash &lt;name&gt;</code></p>
Expand All @@ -1746,6 +1738,14 @@ <h3 id="stash-stash"><a href="stash">stash</a></h3>

<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create Stash context you need to provider username and password.</p>

<h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>

<p><code>codefresh create context git gitlab &lt;name&gt;</code></p>

<p>Create a gitlab context.</p>

<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create gitlab context you need to generate the token here: <a href="https://gitlab.com/profile/personal_access_tokens">https://gitlab.com/profile/personal_access_tokens</a>.</p>




Expand Down
89 changes: 80 additions & 9 deletions contexts/create-context/create-secret-store-context/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1112,6 +1112,62 @@
<a href="/cli/runtime-environments/">Runtime-Environments</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/runtime-environments/get-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/get-runtime-environments/">
Get Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/delete-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/delete-runtime-environments/">
Delete Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/apply-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/apply-runtime-environments/">
Apply Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/attach-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/attach-runtime-environments/">
Attach Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/create-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/create-runtime-environments/">
Create Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/diff-runtime-environments/" class="dd-item">
<div>
<a href="/cli/runtime-environments/diff-runtime-environments/">
Diff Runtime-Environments
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/install-runtime-environment/" class="dd-item">
<div>
<a href="/cli/runtime-environments/install-runtime-environment/">
Install Runtime-Environment
</a>
</div>
</li>
<li data-nav-id="/cli/runtime-environments/uninstall-runtime-environment/" class="dd-item">
<div>
<a href="/cli/runtime-environments/uninstall-runtime-environment/">
Uninstall Runtime-Environment
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/runtime-environments-base-images/" class="dd-item haschildren
Expand Down Expand Up @@ -1533,6 +1589,21 @@
Delete Registry
</a>
</div>
</li>
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
">
<div>
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
<div>
<a href="/cli/registries/registries/standard/">
standard
</a>
</div>
</li>
</ul>
</li>
</ul>
</li>
Expand Down Expand Up @@ -1616,8 +1687,8 @@
<li>
<ul>
<li><a href="#hashicorp-vault-hashicorp-vault"><a href="hashicorp-vault">hashicorp-vault</a></a></li>
<li><a href="#kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></a></li>
<li><a href="#kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></a></li>
<li><a href="#kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></a></li>
</ul></li>
</ul></li>
</ul>
Expand Down Expand Up @@ -1650,14 +1721,6 @@ <h3 id="hashicorp-vault-hashicorp-vault"><a href="hashicorp-vault">hashicorp-vau

<p>Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.</p>

<h3 id="kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></h3>

<p><code>codefresh create context secret-store kubernetes &lt;name&gt;</code></p>

<p>Create a secret-store Kubernetes context.</p>

<p>Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.</p>

<h3 id="kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></h3>

<p><code>codefresh create context secret-store kubernetes-runtime &lt;name&gt;</code></p>
Expand All @@ -1666,6 +1729,14 @@ <h3 id="kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kube

<p>Create a secret store to use hybrid runtime to access K8S secret/configmap and use it as secret store.</p>

<h3 id="kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></h3>

<p><code>codefresh create context secret-store kubernetes &lt;name&gt;</code></p>

<p>Create a secret-store Kubernetes context.</p>

<p>Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.</p>




Expand Down
29 changes: 29 additions & 0 deletions contexts/spec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1575,6 +1575,35 @@
<a href="/cli/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/get-registries/" class="dd-item">
<div>
<a href="/cli/registries/get-registries/">
Get Registries
</a>
</div>
</li>
<li data-nav-id="/cli/registries/delete-registry/" class="dd-item">
<div>
<a href="/cli/registries/delete-registry/">
Delete Registry
</a>
</div>
</li>
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
">
<div>
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
<div>
<a href="/cli/registries/registries/standard/">
standard
</a>
</div>
</li>
</ul>
</li>
</ul>
</li>

Expand Down
15 changes: 15 additions & 0 deletions gitops/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1587,6 +1587,21 @@
Delete Registry
</a>
</div>
</li>
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
">
<div>
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
<div>
<a href="/cli/registries/registries/standard/">
standard
</a>
</div>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 4f9884d

Please sign in to comment.