From d105177e5ea7acdea939674a0a3412f1a58810d0 Mon Sep 17 00:00:00 2001 From: NimRegev Date: Wed, 1 Mar 2023 16:27:34 +0200 Subject: [PATCH 1/2] Fix broken links --- _docs/administration/access-control.md | 2 +- _docs/administration/oauth-setup.md | 2 +- _docs/administration/platform-ip-addresses.md | 2 +- _docs/administration/single-sign-on/sso-setup-oauth2.md | 2 -- _docs/deployment/applications-dashboard.md | 2 +- _docs/deployment/images.md | 2 +- _docs/getting-started/quick-start/create-app-specs.md | 2 +- _docs/getting-started/quick-start/create-rollout.md | 2 +- _docs/getting-started/quick-start/install-hosted.md | 2 +- _docs/getting-started/quick-start/runtime.md | 2 +- _docs/getting-started/quick-start/verify-requirements.md | 2 +- _docs/runtime/monitoring-troubleshooting.md | 2 +- _docs/whats-new/whats-new.md | 2 +- 13 files changed, 12 insertions(+), 14 deletions(-) diff --git a/_docs/administration/access-control.md b/_docs/administration/access-control.md index f97a72d0e..2abffb9cc 100644 --- a/_docs/administration/access-control.md +++ b/_docs/administration/access-control.md @@ -105,4 +105,4 @@ We are working to enhance our access control model by adding another layer to pr * A more granular permission model for dynamic resources that are non-GitOps controlled, but created from a GitOps-controlled entity, for example, workflows ### What to read next -[Codefresh architecture]({{site.baseurl}}/_docs/getting-started/architecture/) +[Codefresh architecture]({{site.baseurl}}/docs/getting-started/architecture/) diff --git a/_docs/administration/oauth-setup.md b/_docs/administration/oauth-setup.md index e56f64bde..1fa82f16b 100644 --- a/_docs/administration/oauth-setup.md +++ b/_docs/administration/oauth-setup.md @@ -216,5 +216,5 @@ For a Git provider and a hybrid runtime, select the authentication mechanism: Co >Hosted runtimes can have either Codefresh or PAT token authentication mechanisms. Custom provider authentication is not supported. 1. In the Codefresh UI, go to [Authentication](https://g.codefresh.io/2.0/account-settings/authentication?providerName=github){:target="\_blank"}. -1. Select the runtime, and click ![](/images/administration/users/icon-Edit.png?display=inline-block) **Edit**. +1. Select the runtime, and click the **Edit** icon. 1. Select the OAuth authentication provider account. \ No newline at end of file diff --git a/_docs/administration/platform-ip-addresses.md b/_docs/administration/platform-ip-addresses.md index 2f95184a1..df30f1d2a 100644 --- a/_docs/administration/platform-ip-addresses.md +++ b/_docs/administration/platform-ip-addresses.md @@ -1,7 +1,7 @@ --- title: "Codefresh IP addresses" description: " " -canonical_url: 'https://codefresh.io/docs/docs/administration/account-user-management/platform-ip-addresses/' +canonical_url: 'https://codefresh.io/docs/docs/administration/platform-ip-addresses/' group: administration toc: true diff --git a/_docs/administration/single-sign-on/sso-setup-oauth2.md b/_docs/administration/single-sign-on/sso-setup-oauth2.md index 93d4f5fc4..716313290 100644 --- a/_docs/administration/single-sign-on/sso-setup-oauth2.md +++ b/_docs/administration/single-sign-on/sso-setup-oauth2.md @@ -157,6 +157,4 @@ steps: {% endraw %} {% endhighlight %} -To fully automate this pipeline, set a [cron trigger]({{site.baseurl}}/docs/configure-ci-cd-pipeline/triggers/cron-triggers/) for this pipeline. The cron-trigger is responsible for running this pipeline, (and therefore synchronizing the teams), in a fully automated manner. -This way you can synchronize your teams every day/week/hour depending on you cron trigger setup. diff --git a/_docs/deployment/applications-dashboard.md b/_docs/deployment/applications-dashboard.md index 14aaea8f5..8e6dd2d42 100644 --- a/_docs/deployment/applications-dashboard.md +++ b/_docs/deployment/applications-dashboard.md @@ -665,7 +665,7 @@ max-width="70%" A rollout is initiated when there is an Argo CD sync due to a change in the desired state. Visualize ongoing and completed rollouts by deployments in **Services**. -> To view and manage a rollout, you must have an Argo `rollout` resource defined for your application, and [install Argo Rollouts in the cluster]({site.baseurl}}/docs/deployment/install-argo-rollouts). +> To view and manage a rollout, you must have an Argo `rollout` resource defined for your application, and [install Argo Rollouts in the cluster]({{site.baseurl}}/docs/deployment/install-argo-rollouts/). For detailed information on Argo Rollouts, see [Argo Rollouts documentation](https://argoproj.github.io/argo-rollouts/){:target="\_blank"}. diff --git a/_docs/deployment/images.md b/_docs/deployment/images.md index 387a65b66..e6ea4110d 100644 --- a/_docs/deployment/images.md +++ b/_docs/deployment/images.md @@ -1,7 +1,7 @@ --- title: "Images in Codefresh" description: "" -canonical_url: 'https://codefresh.io/docs/docs/deployments/gitops/images/' +canonical_url: 'https://codefresh.io/docs/dashboards/images/' group: deployment toc: true --- diff --git a/_docs/getting-started/quick-start/create-app-specs.md b/_docs/getting-started/quick-start/create-app-specs.md index e51ea5f17..74e343e75 100644 --- a/_docs/getting-started/quick-start/create-app-specs.md +++ b/_docs/getting-started/quick-start/create-app-specs.md @@ -1,7 +1,7 @@ --- title: "Create and commit resources for application" description: "" -canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quickstart/create-app-specs/' +canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quick-start/create-app-specs/' group: getting-started sub-group: quick-start toc: true diff --git a/_docs/getting-started/quick-start/create-rollout.md b/_docs/getting-started/quick-start/create-rollout.md index f465a5b03..a75889e35 100644 --- a/_docs/getting-started/quick-start/create-rollout.md +++ b/_docs/getting-started/quick-start/create-rollout.md @@ -1,7 +1,7 @@ --- title: "Update image tag for application" description: "" -canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quickstart/create-rollout/' +canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quick-start/create-rollout/' group: getting-started sub-group: quick-start toc: true diff --git a/_docs/getting-started/quick-start/install-hosted.md b/_docs/getting-started/quick-start/install-hosted.md index df896b4ad..1d780e946 100644 --- a/_docs/getting-started/quick-start/install-hosted.md +++ b/_docs/getting-started/quick-start/install-hosted.md @@ -1,7 +1,7 @@ --- title: "Provision a hosted runtime" description: "" -canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quickstart/install-hosted/' +canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quick-start/install-hosted/' group: getting-started sub-group: quick-start toc: true diff --git a/_docs/getting-started/quick-start/runtime.md b/_docs/getting-started/quick-start/runtime.md index 9ef6c9c60..194c0915d 100644 --- a/_docs/getting-started/quick-start/runtime.md +++ b/_docs/getting-started/quick-start/runtime.md @@ -1,7 +1,7 @@ --- title: "Install a hybrid runtime" description: "" -canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quickstart/runtime/' +canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quick-start/runtime/' group: getting-started sub-group: quick-start toc: true diff --git a/_docs/getting-started/quick-start/verify-requirements.md b/_docs/getting-started/quick-start/verify-requirements.md index a962eb14c..7d51f9a25 100644 --- a/_docs/getting-started/quick-start/verify-requirements.md +++ b/_docs/getting-started/quick-start/verify-requirements.md @@ -1,7 +1,7 @@ --- title: "Prepare for hybrid runtime installation" description: "" -canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quickstart/verify-requirements/' +canonical_url: 'https://codefresh.io/docs/docs/quick-start/gitops-quick-start/verify-requirements/' group: getting-started sub-group: quick-start toc: true diff --git a/_docs/runtime/monitoring-troubleshooting.md b/_docs/runtime/monitoring-troubleshooting.md index 9809db74d..30d4d1a31 100644 --- a/_docs/runtime/monitoring-troubleshooting.md +++ b/_docs/runtime/monitoring-troubleshooting.md @@ -237,7 +237,7 @@ All you need to do is to configure the browser to trust the URL and receive cont The Activity Log is a quick way to monitor notifications for runtime events such as upgrades. A pull-down panel in the Codefresh toolbar, the Activity Log shows ongoing, success, and error notifications, sorted by date, starting with today's date. -1. In the Codefresh UI, on the top-right of the toolbar, select ![](/images/pipeline/monitoring/pipeline-activity-log-toolbar.png?display=inline-block) **Activity Log**. +1. In the Codefresh UI, on the top-right of the toolbar, select **Activity Log**. 1. To see notifications for provisioned runtimes, filter by **Runtime**. {% include image.html diff --git a/_docs/whats-new/whats-new.md b/_docs/whats-new/whats-new.md index 5f57c658f..ca0dc7520 100644 --- a/_docs/whats-new/whats-new.md +++ b/_docs/whats-new/whats-new.md @@ -1195,7 +1195,7 @@ Logs are displayed if the resource has logs: * For online viewing, you have free-text search and line-wrap functionalities. * For offline viewing and analysis, you can download the complete log into a text file. -For details, see [Current State Tree view]({{site.baseurl}}/docs/deployment/applications-dashboard/view-modes-for-application-resources/). +For details, see [Current State Tree view]({{site.baseurl}}/docs/deployment/applications-dashboard/#select-view-mode-for-the-applications-dashboard). #### Application rollout visualization In addition to installing Argo Rollouts in your cluster, visualize Argo Rollout history and progress directly in the Applications (deployment) dashboard. Visualize rollouts from multiple clusters and runtimes in a single centralized location through the Deployment tab. From 13c4c32bb2be356c77a1631564f86f0b125f201f Mon Sep 17 00:00:00 2001 From: NimRegev Date: Thu, 2 Mar 2023 12:13:40 +0200 Subject: [PATCH 2/2] Update sso-setup-oauth2.md --- .../single-sign-on/sso-setup-oauth2.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/_docs/administration/single-sign-on/sso-setup-oauth2.md b/_docs/administration/single-sign-on/sso-setup-oauth2.md index 716313290..3a6fc3393 100644 --- a/_docs/administration/single-sign-on/sso-setup-oauth2.md +++ b/_docs/administration/single-sign-on/sso-setup-oauth2.md @@ -139,22 +139,6 @@ caption="SSO Client Name" max-width="40%" %} -Even though you can run this command manually, it makes more sense to run it periodically as a job. And the obvious -way to perform this is with a Codefresh pipeline. The CLI can be used as a [freestyle step]({{site.baseurl}}/docs/codefresh-yaml/steps/freestyle/). - -You can create a git repository with a [codefresh.yml]({{site.baseurl}}/docs/codefresh-yaml/what-is-the-codefresh-yaml/) file with the following contents: - -`YAML` -{% highlight yaml %} -{% raw %} -version: '1.0' -steps: - syncMyTeams: - title: syncTeams - image: codefresh/cli - commands: - - 'codefresh synchronize teams my-client-name -t azure' -{% endraw %} -{% endhighlight %} +