Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f25f68e

Browse files
authoredMar 27, 2025
Content qa (#1247)
* Updates after review * Updates * Update gitops-apps-dashboard.md * Update installation-options.md * Update monitor-applications.md * Update monitor-applications.md * Added conditions for user tokens * Update manage-pats.md * Add symlink to values validation * Update gitops-runtime.md Removed hosted section * Update gitops-runtime.md * Update ingress arch diagram * Update gitops.md * Update paths for inline images with conditions * Updates * Fix endif tags * Updates after self-review * Updates * Update monitor-applications.md * Update monitor-applications.md
1 parent b35cc37 commit f25f68e

17 files changed

+51
-54
lines changed
 

‎_data/argohub-nav.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,9 @@
208208
- title: Products
209209
url: "/products"
210210
pages:
211-
- title: About Products
211+
- title: About products
212212
url: "/about-products"
213-
- title: Create Products
213+
- title: Create products
214214
url: "/create-product"
215215
- title: Configure Product Settings
216216
url: "/configure-product-settings"
@@ -220,7 +220,7 @@
220220
url: "/promotion-version-properties"
221221
- title: Selecting Promotion Flows
222222
url: "/promotion-flow-triggers"
223-
- title: Tracking Releases for Products
223+
- title: Tracking Releases for products
224224
url: "/releases-in-products"
225225

226226
- title: Applications

‎_docs/administration/single-sign-on/oidc/oidc-okta.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ max-width="60%"
136136
### How to
137137

138138
1. In the Codefresh UI, from the toolbar click the **Settings** icon.
139-
1. In the sidebar, from Access & Collaboration, select [Single Sign-On](https://g.codefresh.io/2.0/account-settings/single-sign-on){:target="\_blank"}.
139+
1. In the sidebar, from Access & Collaboration, select **Single Sign-On**.
140140
1. Select **+ Add Single Sign-On**, select **Okta** and then click **Next**.
141141

142142
{% include image.html
@@ -167,7 +167,7 @@ max-width="30%"
167167
Though you can assign an Okta application to both groups and individual users, Codefresh _only syncs users who are part of teams_.<br>
168168
New users in Okta, _not_ assigned to a team, are **NOT** synced with Codefresh. You should first assign the user to a team for the sync to work.
169169
1. Optional. To also remove individual users who have been deactivated in Okta from their Codefresh accounts during sync, select **Remove deactivated users during sync**.
170-
When selected, deactivated users are removed from the current account, _and_ from all the accounts defined in **Additional accounts to sync**, if any. Their names are removed from both the Users list and from the Teams to which they belong in [Users and Teams](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}).
170+
When selected, deactivated users are removed from the current account, _and_ from all the accounts defined in **Additional accounts to sync**, if any. Their names are removed from both the Users list and from the Teams to which they belong in Users and Teams.
171171
If not selected, the deactivated users are automatically removed from the Team or Teams to which they belong, but still displayed in the Users list.
172172
1. Select **+Add**.
173173
Codefresh automatically generates the **Client Name** to which to identify the SSO configuration.

‎_docs/administration/user-self-management.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ description: "Learn how to manage personal settings"
44
group: administration
55
toc: true
66
---
7-
{% if page.collection != site.gitops_collection %}
8-
You can change your email notifications and API keys through [settings]({{site.baseurl}}/docs/administration/user-self-management/user-settings/).
97

10-
For GitOps integrations you can also manage [your own Git tokens]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/).
11-
{% endif %}
8+
As a user, you can change your email notifications and API keys through [settings]({{site.baseurl}}/docs/administration/user-self-management/user-settings/).
9+
10+
You can also manage [your own Git tokens]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/).
1211

13-
{% if page.collection == site.gitops_collection %}
14-
For GitOps integrations you can also manage [your own Git tokens]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/).
15-
{% endif %}
1612

‎_docs/deployments/gitops/application-configuration-settings.md

-1
Original file line numberDiff line numberDiff line change
@@ -156,5 +156,4 @@ For example applications, go to the [Argo CD example applications repo](https://
156156
[Promotions]({{site.baseurl}}/docs/promotions/promotions-overview/)
157157
[Manage products and applications in environments]({{site.baseurl}}/docs/environments/manage-apps-in-environments/)
158158
[Product Dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/)
159-
[Home dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
160159
{% if page.collection != site.gitops_collection %}[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/){% endif %}

‎_docs/deployments/gitops/create-application.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ spec:
133133
## Related articles
134134
[Monitoring Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/monitor-applications/)
135135
[Managing Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/)
136+
[Trigger promotions for applications]({{site.baseurl}}/docs/promotions/trigger-promotions/)
136137
[Environments]({{site.baseurl}}/docs/environments/environments-overview/)
137138
[Products]({{site.baseurl}}/docs/products/about-products/)
138-
[Trigger promotions for applications]({{site.baseurl}}/docs/promotions/trigger-promotions/)
139-
[Home dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
140139
{% if page.collection != site.gitops_collection %}[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/){% endif %}

‎_docs/deployments/gitops/gitops-app-groups.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ max-width="60%"
9797
9898
You can:
9999
* Filter by one or more applications to find the Groups they belong to.
100-
* Star one or more Application Groups as favorites for single-click access to them.{::nomarkdown}<br>Click <img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block"> to star a Group, and click <img src="../../../../images/icons/icon-fav-starred.png?display=inline-block"> to view starred Groups.{:}.
100+
* Star one or more Application Groups as favorites for single-click access to them.{::nomarkdown}<br>Click {% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/icon-mark-favorite.png?display=inline-block">{% endif %} to star a Group, and click {% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/icon-fav-starred.png?display=inline-block">{% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../../images/icons/icon-fav-starred.png?display=inline-block">{% endif %} to view starred Groups.{:/}.
101101
* Select a Group to view the Timelines of the applications in it.
102102
* Navigate to the Card views of its applications by clicking Applications.
103103

‎_docs/deployments/gitops/manage-application.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ There are two aspects to managing Argo CD applications in Codefresh GitOps:
6565
To delete specific resources within an application, see [Delete application resources]({{site.baseurl}}/docs/deployments/gitops/monitor-applications/#delete-application-resources).
6666

6767

68-
## GitOps environments & Argo CD applications
68+
## Environments & Argo CD applications
6969
Tracking and managing deployments at scale requires clear visibility into applications at every stage. Codefresh GitOps provides this visibility through environments.
7070
When you define an environment by specifying one or more cluster-namespace pairs, Codefresh automatically detects and displays the applications deployed to those locations.
7171

@@ -798,7 +798,6 @@ metadata:
798798
[GitOps Apps dashboard]({{site.baseurl}}/docs/dashboards/gitops-apps-dashboard/)
799799
[Environments dashboard]({{site.baseurl}}/docs/dashboards/gitops-environments/)
800800
[Products dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/)
801-
[Home dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
802801
{% if page.collection != site.gitops_collection %}[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/){% endif %}
803802

804803

‎_docs/deployments/gitops/monitor-applications.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -355,12 +355,12 @@ The table describes the possible health statuses for an application resource in
355355
{: .table .table-bordered .table-hover}
356356
| Health icon | Health status | Description |
357357
| -------------- | ------------| ------------------|
358-
| {::nomarkdown}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{:/} | **Healthy** | Resource is functioning as required. |
359-
| {::nomarkdown}<img src="../../../../images/icons/current-state-progressing.png" display=inline-block">{:/} | **Progressing** | Resource is not healthy but can become healthy before the timeout occurs. |
360-
| {::nomarkdown}<img src="../../../../images/icons/current-state-suspended.png" display=inline-block">{:/} | **Suspended** | Resource is not functioning, and is either suspended or paused. For example, Cron job or a canary rollout.|
361-
|{::nomarkdown}<img src="../../../../images/icons/current-state-missing.png" display=inline-block">{:/} | **Missing** | Resource is not present on the cluster. |
362-
| {::nomarkdown}<img src="../../../../images/icons/current-state-degraded.png" display=inline-block/>{:/} | **Degraded** | Resource is not healthy, or a timeout occurred before it could reach a healthy status. |
363-
| {::nomarkdown}<img src="../../../../images/icons/current-state-unknown.png" display=inline-block/>{:/} | **Unknown** | Resource does not have a health status, or the health status is not tracked in Argo CD. For example, `ConfigMaps` resource types. |
358+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{% endif %}{:/} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-healthy.png" display=inline-block">{% endif %}{:/} | **Healthy** | Resource is functioning as required. |
359+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-progressing.png" display=inline-block">{:/} {% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-progressing.png" display=inline-block">{:/} {% endif %} | **Progressing** | Resource is not healthy but can become healthy before the timeout occurs. |
360+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-suspended.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-suspended.png" display=inline-block">{% endif %}{:/} | **Suspended** | Resource is not functioning, and is either suspended or paused. For example, Cron job or a canary rollout.|
361+
|{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-missing.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-missing.png" display=inline-block">{% endif %}{:/} | **Missing** | Resource is not present on the cluster. |
362+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-degraded.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-degraded.png" display=inline-block/>{% endif %}{:/} | **Degraded** | Resource is not healthy, or a timeout occurred before it could reach a healthy status. |
363+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-unknown.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-unknown.png" display=inline-block/>{% endif %}{:/} | **Unknown** | Resource does not have a health status, or the health status is not tracked in Argo CD. For example, `ConfigMaps` resource types. |
364364

365365

366366
See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/){:target="\_blank"}.
@@ -377,9 +377,9 @@ The table describes the possible sync states for an application resource in the
377377
{: .table .table-bordered .table-hover}
378378
| Sync icon | Sync state |Description |
379379
| -------------- | ---------- | ---------- |
380-
| {::nomarkdown}<img src="../../../../images/icons/current-state-synced.png" display=inline-block">{:/} | **Synced** | The live state of the resource on the cluster is identical to the desired state in Git.|
381-
| {::nomarkdown}<img src="../../../../images/icons/current-state-syncing.png" display=inline-block/>{:/}| **Syncing** | The live state of the resource was not identical to the desired state, and is currently being synced. |
382-
| {::nomarkdown}<img src="../../../../images/icons/current-state-out-of-sync.png" display=inline-block">{:/}| **Out-of-Sync** | The live state is not identical to the desired state.<br>To sync a resource, select the **Sync** option from the resource's context menu in Tree view. |
380+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-synced.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-synced.png" display=inline-block">{% endif %}{:/} | **Synced** | The live state of the resource on the cluster is identical to the desired state in Git.|
381+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-syncing.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-syncing.png" display=inline-block/>{% endif %}{:/}| **Syncing** | The live state of the resource was not identical to the desired state, and is currently being synced. |
382+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-out-of-sync.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-out-of-sync.png" display=inline-block">{% endif %}{:/}| **Out-of-Sync** | The live state is not identical to the desired state.<br>To sync a resource, select the **Sync** option from the resource's context menu in Tree view. |
383383
| No icon | **Unknown** | The sync status could not be determined. |
384384

385385

@@ -426,7 +426,7 @@ max-width="50%"
426426

427427

428428
### Tree view: Access external links
429-
Resources with annotations for external links, display {::nomarkdown}<img src="../../../../images/icons/external-link-resources.png" display=inline-block">{:/} below their context menu. Ingress resources automatically display external links. Clicking the icon lists available links.
429+
Resources with annotations for external links, display {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/external-link-resources.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/external-link-resources.png" display=inline-block">{% endif %}{:/} below their context menu. Ingress resources automatically display external links. Clicking the icon lists available links.
430430
For more details on this feature, see [Argo CD's documentation on Adding external URLs](https://argo-cd.readthedocs.io/en/stable/user-guide/external-url/){:target="\_blank"}.
431431

432432
>**NOTE**
@@ -449,7 +449,7 @@ caption="External links for deployment resource in Current State Tree view"
449449
max-width="50%"
450450
%}
451451
452-
Clicking {::nomarkdown}<img src="../../../../images/icons/external-link-resources.png" display=inline-block">{:/} displays the links configured.
452+
Clicking {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/external-link-resources.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/external-link-resources.png" display=inline-block">{% endif %}{:/} displays the links configured.
453453
454454
455455
@@ -631,10 +631,10 @@ The table lists the controls in the Rollout Player to manage an ongoing rollout.
631631
{: .table .table-bordered .table-hover}
632632
|Rollback player icon | Option | Description |
633633
| -------------- | ------------|
634-
| {::nomarkdown}<img src="../../../../images/icons/rollout-rollback.png" display=inline-block"> {:/} | **Rollback** | Rollback rollout to the selec. |
635-
| {::nomarkdown}<img src="../../../../images/icons/rollout-resume.png" display=inline-block"> {:/} |**Resume** | Resume a step that has been paused indefinitely. |
636-
| {::nomarkdown}<img src="../../../../images/icons/rollout-skip-step.png" display=inline-block"> {:/} | **Skip step** | Skip execution of current step. Such steps are marked as Skipped in the rollout visualization. |
637-
| {::nomarkdown}<img src="../../../../images/icons/rollout-promote-full.png" display=inline-block"> {:/}| **Promote full rollout** | Skip remaining pause, traffic routing, and analysis steps, and deploy the current release. |
634+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/rollout-rollback.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/rollout-rollback.png" display=inline-block">{% endif %} {:/} | **Rollback** | Rollback rollout to the selec. |
635+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/rollout-resume.png" display=inline-block">{% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/rollout-resume.png" display=inline-block">{% endif %}{:/} |**Resume** | Resume a step that has been paused indefinitely. |
636+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/rollout-skip-step.png" display=inline-block">{% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/rollout-skip-step.png" display=inline-block">{% endif %}{:/} | **Skip step** | Skip execution of current step. Such steps are marked as Skipped in the rollout visualization. |
637+
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/rollout-promote-full.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/rollout-promote-full.png" display=inline-block">{% endif %} {:/}| **Promote full rollout** | Skip remaining pause, traffic routing, and analysis steps, and deploy the current release. |
638638

639639

640640

@@ -695,7 +695,6 @@ max-width="50%"
695695
[Troubleshooting Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/troubleshooting-gitops-apps/)
696696
[Environments dashboard]({{site.baseurl}}/docs/dashboards/gitops-environments/)
697697
[Products dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/)
698-
[Home dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
699698
{% if page.collection != site.gitops_collection %}[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/){% endif %}
700699

701700

‎_docs/environments/manage-apps-in-environments.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Use the Environments dashboard to:
1919
## Filter applications in environments by health status
2020
Quickly filter applications within an Environment by health status. For health status descriptions, see [Health status for application resources]({{site.baseurl}}/docs/deployments/gitops/monitor-applications/#health-status-for-application-resources).
2121

22-
1. In the Codefresh UI, from the sidebar, select [**Environments**](https://g.codefresh.io/2.0/environments?view=compact){:target="\_blank"}.
22+
1. In the Codefresh UI, from the sidebar, select **Environments**.
2323
1. For any Environment, click the Health status or statuses by which to filter.
2424
The Environment displays those applications that match the selected status.
2525

@@ -38,7 +38,7 @@ Quickly filter applications within an Environment by health status. For health s
3838
Promote a product or application from the Environments dashboard using one of two methods:
3939
* **Drag-and-drop promotion**
4040
Manually move a product or application from one environment to another, and define the Promotion Settings. Use this method to quickly test changes, such as promoting an application from development to testing.
41-
* **Promote action**
41+
* **Promote action**
4242
Instead of drag-and-drop, select the target environment to promote to, or trigger a predefined Promotion Flow configured with promotion settings, including the action, and Pre-Action and Post-Action Workflows. This method is best for structured promotions that follow defined policies.
4343

4444

There was a problem loading the remainder of the diff.

0 commit comments

Comments
 (0)
Failed to load comments.