Publish new documentation for version 0.88.3

codefresh-io · Nov 27, 2024 · 78cc5a1 · 78cc5a1
1 parent 21d7332
commit 78cc5a1
Show file tree

Hide file tree

Showing 22 changed files with 314 additions and 1,418 deletions.
diff --git a/audit/download/index.html b/audit/download/index.html
@@ -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-24_13-20-51.csv</td>
+<td>/codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv</td>
 <td>The name of the file and the directory in which the audit will be saved</td>
 </tr>
 </tbody>

diff --git a/components/index.html b/components/index.html
@@ -853,13 +853,6 @@
       <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

diff --git a/compositions/index.html b/compositions/index.html
@@ -1313,13 +1313,6 @@
       <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

diff --git a/contexts/create-context/create-git-context/index.html b/contexts/create-context/create-git-context/index.html
@@ -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="#stash-stash"><a href="stash">stash</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>
 </ul></li>
 </ul></li>
 </ul>
@@ -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="stash-stash"><a href="stash">stash</a></h3>
-
-<p><code>codefresh create context git stash &lt;name&gt;</code></p>
-
-<p>Create a stash 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 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>
@@ -1746,6 +1738,14 @@ <h3 id="gitlab-gitlab"><a href="gitlab">gitlab</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 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>
+
+<p>Create a stash 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 Stash context you need to provider username and password.</p>
+
 
 
 

diff --git a/contexts/create-context/create-secret-store-context/index.html b/contexts/create-context/create-secret-store-context/index.html
@@ -1112,62 +1112,6 @@
       <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
@@ -1589,21 +1533,6 @@
             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>

diff --git a/contexts/create-context/index.html b/contexts/create-context/index.html
@@ -870,6 +870,20 @@
       <a href="/cli/components/">Components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
       </div>
         <ul>
+      <li data-nav-id="/cli/components/download/" class="dd-item">
+        <div>
+          <a href="/cli/components/download/">
+            Download
+          </a>
+        </div>
+    </li>
+      <li data-nav-id="/cli/components/update/" class="dd-item">
+        <div>
+          <a href="/cli/components/update/">
+            Update
+          </a>
+        </div>
+    </li>
         </ul>
     </li>
     <li data-nav-id="/cli/environments/" class="dd-item haschildren

diff --git a/contexts/spec/index.html b/contexts/spec/index.html
@@ -1575,35 +1575,6 @@
       <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>
 

diff --git a/gitops/index.html b/gitops/index.html
@@ -415,6 +415,34 @@
       <a href="/cli/contexts/create-context/create-git-context/">Git</a><i class="fa fa-angle-right fa-lg category-icon"></i>
       </div>
         <ul>
+      <li data-nav-id="/cli/contexts/create-context/create-git-context/bitbucket/" class="dd-item">
+        <div>
+          <a href="/cli/contexts/create-context/create-git-context/bitbucket/">
+            bitbucket
+          </a>
+        </div>
+    </li>
+      <li data-nav-id="/cli/contexts/create-context/create-git-context/github/" class="dd-item">
+        <div>
+          <a href="/cli/contexts/create-context/create-git-context/github/">
+            github
+          </a>
+        </div>
+    </li>
+      <li data-nav-id="/cli/contexts/create-context/create-git-context/gitlab/" class="dd-item">
+        <div>
+          <a href="/cli/contexts/create-context/create-git-context/gitlab/">
+            gitlab
+          </a>
+        </div>
+    </li>
+      <li data-nav-id="/cli/contexts/create-context/create-git-context/stash/" class="dd-item">
+        <div>
+          <a href="/cli/contexts/create-context/create-git-context/stash/">
+            stash
+          </a>
+        </div>
+    </li>
         </ul>
     </li>
     <li data-nav-id="/cli/contexts/create-context/create-helm-repository-context/" class="dd-item haschildren

diff --git a/gitops/install/index.html b/gitops/install/index.html
@@ -1587,21 +1587,6 @@
             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>

diff --git a/index.json b/index.json
@@ -900,7 +900,7 @@
 	"title": "Download",
 	"tags": [],
 	"description": "",
-	"content": " Description Download audit.\nCommand codefresh download audit\nOptions    Option Alias Type Default Description     --help    Print help information   --userName    filter by user name   --userId    filter by codefresh user id   --entity    filter by api entity, example: pipeline, account   --entityId    filter by api entity id, this value different for each action, example: email, user id   --action    filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account   --rs_status    filter by response status code   --showTriggers    returns only actions related to receiving triggers   --search    filter by searching substring in request body or query or params or headers or url   --from    filter by date, value is number of milliseconds since 1970   --to    filter by date, value is number of milliseconds since 1970   --sortField    name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt   --sortType    sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK   --file  string /codefresh/volume/cli/codefresh_audit_2024-11-24_13-20-51.csv The name of the file and the directory in which the audit will be saved    Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n"
+	"content": " Description Download audit.\nCommand codefresh download audit\nOptions    Option Alias Type Default Description     --help    Print help information   --userName    filter by user name   --userId    filter by codefresh user id   --entity    filter by api entity, example: pipeline, account   --entityId    filter by api entity id, this value different for each action, example: email, user id   --action    filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account   --rs_status    filter by response status code   --showTriggers    returns only actions related to receiving triggers   --search    filter by searching substring in request body or query or params or headers or url   --from    filter by date, value is number of milliseconds since 1970   --to    filter by date, value is number of milliseconds since 1970   --sortField    name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt   --sortType    sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK   --file  string /codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv The name of the file and the directory in which the audit will be saved    Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n"
 },
 {
 	"uri": "https://codefresh-io.github.io/cli/more/image-pull-secret/",
@@ -949,7 +949,7 @@
 	"title": "Triggers",
 	"tags": [],
 	"description": "",
-	"content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n"
+	"content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n"
 },
 {
 	"uri": "https://codefresh-io.github.io/cli/contexts/update-context/",
@@ -1117,7 +1117,7 @@
 	"title": "Git",
 	"tags": [],
 	"description": "",
-	"content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\n"
+	"content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\n"
 },
 {
 	"uri": "https://codefresh-io.github.io/cli/gitops/",