Skip to content

Commit fc7d006

Browse files
NimRegevNimRegev
authored
Merge branch 'master' into command-bar
2 parents 7acf8a2 + 40ca158 commit fc7d006

File tree

363 files changed

+15136
-5963
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

363 files changed

+15136
-5963
lines changed

‎CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @kostis-codefresh @jesse-codefresh
1+
* luke.goodfellow@codefresh.io nima.regev@codefresh.io

‎_config.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ exclude:
6767
plugins:
6868
- jekyll-redirect-from
6969
- jekyll-sitemap
70+
- jekyll-feed
7071
- jekyll-github-metadata
7172
- jemoji
7273

@@ -91,7 +92,9 @@ defaults:
9192
path: "_posts"
9293
type: posts
9394
values:
94-
layout: simple
95+
layout: docs
96+
toc: true
97+
wide: true
9598
# _pages
9699
- scope:
97100
path: "_pages"
@@ -107,6 +110,10 @@ defaults:
107110
toc: true
108111
wide: true
109112

113+
# #RSS Feed Location
114+
feed:
115+
path: /changelog/feed.xml
116+
110117
# Custom variables
111118
repo: "https://github.com/codefresh-io/docs.codefresh.io"
112119
features: "https://codefresh.io/features/"
@@ -144,3 +151,5 @@ compress_html:
144151
startings: [head, body]
145152
ignore:
146153
envs: development
154+
155+
kb-cat: [Pipelines, Workflows, Ops, Artifacts & Insights, Settings, Runtimes, On-Prem, API, CLI, General]

‎_data/home-content.yml

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@
9191
icon: images/home-icons/guides.png
9292
url: ''
9393
links:
94-
- title: GitOps Overview dashboard
95-
localurl: /docs/dashboards/home-dashboard/
94+
- title: Home dashboard
95+
localurl: /docs/dashboards/home-dashboard/
9696
- title: DORA metrics
9797
localurl: /docs/dashboards/dora-metrics/
9898
- title: Images
@@ -227,14 +227,16 @@
227227
localurl: /docs/installation/installation-options/
228228
- title: Codefresh Runner installation
229229
localurl: /docs/installation/codefresh-runner/
230-
- title: On-Premises installation
231-
localurl: /docs/installation/codefresh-on-prem/
232-
- title: On-Premises upgrade
233-
localurl: /docs/installation/codefresh-on-prem-upgrade/
234-
- title: Hosted GitOps installation
230+
- title: On-Premises platform installation
231+
localurl: /docs/installation/on-premises/codefresh-on-prem/
232+
- title: On-Premises platform upgrade
233+
localurl: /docs/installation/on-premises/codefresh-on-prem-upgrade/
234+
- title: Hosted GitOps Runtime installation
235235
localurl: /docs/installation/gitops/hosted-runtime/
236-
- title: Hybrid GitOps installation
237-
localurl: /docs/installation/gitops/hybrid-gitops/
236+
- title: Hybrid GitOps Runtime installation
237+
localurl: /docs/installation/gitops/hybrid-gitops-helm-installation/
238+
- title: On-premises GitOps Runtime installation
239+
localurl: /docs/installation/gitops/on-prem-gitops-runtime-install/
238240

239241

240242

@@ -280,8 +282,7 @@
280282
localurl: /docs/reference/git-tokens/
281283
- title: Secrets for GitOps
282284
localurl: /docs/reference/secrets
283-
- title: Shared configuration repo
284-
localurl: /docs/reference/shared-configuration/
285+
285286

286287

287288
- title: "Incubation"
@@ -296,6 +297,14 @@
296297
localurl: /docs/incubation/arm-support
297298

298299

299-
300-
300+
- title: "Knowledge Base"
301+
icon: images/home-icons/troubleshooting.svg
302+
url: ''
303+
links:
304+
- title: Common Issues
305+
localurl: /docs/kb/common-issues
306+
- title: How Tos
307+
localurl: /docs/kb/how-to
308+
- title: Troubleshooting
309+
localurl: /docs/kb/troubleshooting
301310

‎_data/nav.yml

Lines changed: 41 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
- title: Dashboards & insights
5555
url: "/dashboards"
5656
pages:
57-
- title: GitOps Overview dashboard
57+
- title: Home dashboard
5858
url: "/home-dashboard"
5959
- title: DORA metrics
6060
url: "/dora-metrics"
@@ -319,6 +319,8 @@
319319
url: "/jfrog"
320320
- title: Quay Registry
321321
url: "/quay"
322+
- title: Gerrit Git provider integration
323+
url: "/gerrit-integration"
322324

323325
- title: Deployments
324326
url: "/deployments"
@@ -372,6 +374,17 @@
372374
url: "/introduction-to-codefresh-pipelines"
373375
- title: Creating pipelines
374376
url: "/pipelines"
377+
- title: Configuration for pipelines
378+
url: "/configuration"
379+
sub-pages:
380+
- title: Global pipeline settings
381+
url: "/pipeline-settings"
382+
- title: Shared configuration
383+
url: "/shared-configuration"
384+
- title: Secrets for pipelines
385+
url: "/secrets-store"
386+
- title: Public logs and status badges
387+
url: "/build-status"
375388
- title: Steps in pipelines
376389
url: "/steps"
377390
sub-pages:
@@ -432,17 +445,6 @@
432445
url: "/deployment-environments"
433446
- title: Running pipelines locally
434447
url: "/running-pipelines-locally"
435-
- title: Configuration for pipelines
436-
url: "/configuration"
437-
sub-pages:
438-
- title: Global pipeline settings
439-
url: "/pipeline-settings"
440-
- title: Shared configuration
441-
url: "/shared-configuration"
442-
- title: Secrets for pipelines
443-
url: "/secrets-store"
444-
- title: Public logs and status badges
445-
url: "/build-status"
446448
- title: Service containers
447449
url: "/service-containers"
448450
- title: Docker image metadata
@@ -496,19 +498,28 @@
496498
url: "/behind-the-firewall"
497499
- title: Runner
498500
url: "/codefresh-runner"
499-
- title: On-Premises installation & configuration
500-
url: "/codefresh-on-prem"
501-
- title: On-Premises upgrade
502-
url: "/codefresh-on-prem-upgrade"
501+
- title: On-premises
502+
url:
503+
sub-pages:
504+
- title: Platform installation & configuration
505+
url: "/codefresh-on-prem"
506+
- title: Platform upgrade
507+
url: "/codefresh-on-prem-upgrade"
508+
- title: Feature management
509+
url: "/on-prem-feature-management"
503510
- title: GitOps
504511
url:
505512
sub-pages:
506513
- title: Hosted GitOps Runtime
507514
url: "/hosted-runtime"
508515
- title: Hybrid GitOps Runtime
509-
url: "/hybrid-gitops"
516+
url: "/hybrid-gitops-helm-installation"
517+
- title: On-premises GitOps Runtime
518+
url: "/on-prem-gitops-runtime-install"
510519
- title: Managing & monitoring GitOps Runtimes
511520
url: "/monitor-manage-runtimes"
521+
- title: Shared Configuration Repository
522+
url: "/shared-configuration"
512523
- title: Add external clusters to GitOps Runtimes
513524
url: "/managed-cluster"
514525
- title: Add Git Sources to to GitOps Runtimes
@@ -589,18 +600,14 @@
589600
url: "/git-tokens"
590601
- title: Secrets
591602
url: "/secrets"
592-
- title: Shared configuration repo
593-
url: "/shared-configuration"
594603

595604
- title: What's new
596605
url: "/whats-new"
597606
pages:
598-
- title: Release notes
599-
url: "/release-notes/"
600-
- title: Changelog
607+
- title: SaaS
601608
url: "/changelog"
602-
- title: GitOps what's new
603-
url: "/gitops-whats-new"
609+
- title: On-premises
610+
url: "/on-prem-release-notes"
604611

605612
- title: Codefresh New Experience
606613
url: "/new-codefresh"
@@ -610,7 +617,8 @@
610617
- title: Navigation quick reference
611618
url: "/menu-navigation"
612619
- title: Documentation changes
613-
url: "/doc-changes"
620+
url: "/doc-changes"
621+
614622

615623
- title: Incubation
616624
url: "/incubation"
@@ -622,60 +630,15 @@
622630
- title: ARM architecture support
623631
url: "/arm-support"
624632

625-
- title: Troubleshooting
626-
url: "/troubleshooting"
633+
- title: Knowledge Base
634+
url: "/kb"
627635
pages:
628636
- title: Common Issues
629637
url: "/common-issues"
630-
sub-pages:
631-
- title: Can't find your organization repositories
632-
url: "/cant-find-your-organization-repositories"
633-
- title: Can’t find your private repositories
634-
url: "/cant-find-your-private-repositories"
635-
- title: 'Clone step failed: Command [git checkout $REVISION] exited with code [1]'
636-
url: "/git-clone-step-issue"
637-
- title: Handling commit messages with a quote character
638-
url: "/handling-commit-messages-with-quotes"
639-
- title: Docker image does not exist or no pull access
640-
url: "/the-docker-image-does-not-exist-or-no-pull-access"
641-
- title: 'Build step: No such file or directory'
642-
url: "/build-step-no-such-file-or-directory"
643-
- title: No Dockerfile found
644-
url: "/no-dockerfile-found"
645-
- title: Failed to create container of image
646-
url: "/create-container-failure"
647-
- title: Failed to tag image
648-
url: "/could-not-tag-image"
649-
- title: Error Code 137
650-
url: "/error-code-137"
651-
- title: Too many requests
652-
url: "/dockerhub-rate-limit"
653-
- title: Restoring data from pre-existing image hangs on
654-
url: "/restoring-data-from-pre-existing-image-hangs-on"
655-
- title: Disabling codefresh caching mechanisms
656-
url: "/disabling-codefresh-caching-mechanisms"
657-
- title: Pinning codefresh.yml for multi-git triggers
658-
url: "/multi-git-triggers"
659-
- title: Workflow terminated by the system
660-
url: "/workflow-terminated-by-system"
661-
- title: cf_export limitations
662-
url: "/cf-export-limitations"
663-
- title: Validation port warnings
664-
url: "/validation-port-warnings"
665-
- title: Forbidden Kubernetes resources
666-
url: "/forbidden-cluster-resources"
667-
- title: How to use SSH keys in freestyle steps
668-
url: "using-ssh-keys"
669-
- title: Failed to get accounts clusters during workflow
670-
url: "/failed-to-get-accounts-clusters-during-workflow"
671-
- title: Paging issues for builds and images
672-
url: "/paging-issues-builds-images"
673-
- title: Deprecating personal Git integrations
674-
url: "/personal-git-deprecation"
675-
- title: GitOps runtimes
676-
url: "/runtime-issues"
677-
678-
638+
- title: How Tos
639+
url: "/how-to"
640+
- title: Troubleshooting
641+
url: "/troubleshooting"
679642

680643
- title: Terms and Privacy Policy
681644
url: "/terms-and-privacy-policy"
@@ -686,5 +649,7 @@
686649
url: "/privacy-policy"
687650
- title: Service Commitment
688651
url: "/sla"
652+
- title: Codefresh SLA Definitions
653+
url: "/codefresh-sla-definitions"
689654

690655

‎_docs/administration/account-user-management/add-users.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,10 @@ As an administrator, you can optionally define session timeouts to automatically
113113

114114
## Troubleshoot add users
115115

116-
* [User is prompted to enter an organization name](https://support.codefresh.io/hc/en-us/articles/360020177959-User-is-prompted-to-enter-an-organization-name){:target="\_blank"}
117-
* [Account invitation not permitting login](https://support.codefresh.io/hc/en-us/articles/360015251000-Account-invitation-not-permitting-login){:target="\_blank"}
116+
* [Account invitation not permitting login]({{site.baseurl}}/docs/kb/articles/account-invite-not-permitting-login){:target="\_blank"}
118117
<!--this is already mentioned as inline refs; add other topics-->
119118

120119
## Related articles
121120
[Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
122121
[Single Sign on]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
123122
[Setting up OAuth authentication for Git providers]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup)
124-

‎_docs/ci-cd-guides/gitops-deployments.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Starting with pointers on setting up Git repos, this guide takes you through the
3232
* Creating a CI pipeline for GitOps
3333
* Creating an Argo CD application for GitOps
3434
* Deploying the application
35-
* Working with the GitOps Apps dashboard, and a look at the insights from the GitOps Overview and DORA dashboards
35+
* Working with the GitOps Apps dashboard, and a look at the insights from the GitOps Dashboard (Home) and DORA dashboards
3636

3737

3838

@@ -448,22 +448,22 @@ The Configuration tab displays the definitions for the application. Apart from t
448448

449449
For more information on application definitions, see [Creating GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application).
450450

451-
## GitOps Overview and DORA dashboards
451+
## GitOps Dashboard and DORA dashboards
452452

453-
If you have several applications and deployments, the GitOps Overview and the DORA metrics dashboards are the go-to dashboards for managers and developers alike.
453+
If you have several applications and deployments, the GitOps Dashboard and the DORA metrics dashboards are the go-to dashboards for managers and developers alike.
454454

455-
The **GitOps Overview** dashboard offers a global view of runtimes, managed clusters, and deployments. For system-wide visualization in real-time, this is your dashboard of choice in Codefresh.
456-
* Go to [GitOps Overview](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
455+
The **GitOps Dashboard**, part of the Home dashboard, offers a global view of runtimes, managed clusters, deployments, and applications. For system-wide visualization in real-time, this is your dashboard of choice in Codefresh.
456+
* Go to [GitOps Dashboard](https://g.codefresh.io/2.0/?startDateFrom=2023-04-26&startDateTo=2023-05-03&time=LAST_7_DAYS){:target="\_blank"}.
457457

458-
For information on the GitOps Overview dashboard, see [GitOps Overview dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard).
458+
For detailed information, see [GitOps Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/#gitops-dashboard).
459459

460460
{% include
461461
image.html
462462
lightbox="true"
463-
file="/images/reporting/gitops-overview-dashboard.png"
464-
url="/images/reporting/gitops-overview-dashboard.png"
465-
alt="GitOps Overview dashboard"
466-
caption="GitOps Overview dashboard"
463+
file="/images/reporting/home-dashboard-gitops.png"
464+
url="/images/reporting/home-dashboard-gitops.png"
465+
alt="Home Dashboard: GitOps"
466+
caption="Home Dashboard: GitOps"
467467
max-width="50%"
468468
%}
469469

@@ -484,14 +484,14 @@ max-width="80%"
484484

485485
## Using the App-of-Apps pattern
486486

487-
The GitOps Overview dashboard displays applications created using the [app-of-apps pattern](https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/){:target="\_blank"}. If you have a number of applications that are related, and you always
487+
The GitOps Apps dashboard displays applications created using the [app-of-apps pattern](https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/){:target="\_blank"}. If you have a number of applications that are related, and you always
488488
install them as a set in your cluster, you can group them in a single Application. The parent application can be defined using [declarative Argo Resources](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/){:target="\_blank"}.
489489

490490
As an example, you might find that you always install in your cluster Linkerd, Prometheus and Ambassador. You can group all of them in a single Application and deploy them all at once.
491491

492492
You can find an existing example of app-of-apps at [https://github.com/argoproj/argocd-example-apps/tree/master/apps](https://github.com/argoproj/argocd-example-apps/tree/master/apps){:target="\_blank"}. It uses [Helm]({{site.baseurl}}/docs/example-catalog/cd-examples/helm/), but you can use any other Kubernetes templating mechanism such as [Kustomize]({{site.baseurl}}/docs/example-catalog/cd-examples/deploy-with-kustomize/), or even plain manifests.
493493

494-
Once you deploy the application with Codefresh, the parent app is displayed in the GitOps Overview dashboard with an arrow.
494+
Once you deploy the application with Codefresh, the parent app is displayed in the GitOps Apps dashboard with an arrow.
495495
Clicking the arrow expand and displays the child applications.
496496

497497
{% include image.html

‎_docs/ci-cd-guides/preview-environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ You can combine the pipeline above with any Codefresh UI dashboard if you want t
332332
For more information, see:
333333
* [Environment dashboard]({{site.baseurl}}/docs/deployments/kubernetes/environment-dashboard/)
334334
* [Helm promotion dashboard]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion/)
335-
* [GitOps dashboard]({{site.baseurl}}/docs/ci-cd-guides/gitops-deployments/#working-with-the-gitops-dashboard)
335+
* [GitOps deployments]({{site.baseurl}}/docs/ci-cd-guides/gitops-deployments/#working-with-the-gitops-dashboard)
336336

337337

338338

‎_docs/dashboards/dora-metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ More than one option within the same filter type has an OR relationship. Multipl
4646
> When no filters are defined, all metrics are shown for the last 90 days.
4747
4848
## Metrics for favorite applications
49-
If you have [starred applications as favorites]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#applications-dashboard-information) in the Applications dashboard, clicking {::nomarkdown}<img src="../../../images/icons/icon-mark-favorite.png?display=inline-block">{:/} in DORA metrics, displays DORA metrics only for those applications.
49+
If you have [starred applications as favorites]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#gitops-apps-dashboard-information) in the Applications dashboard, clicking {::nomarkdown}<img src="../../../images/icons/icon-mark-favorite.png?display=inline-block">{:/} in DORA metrics, displays DORA metrics only for those applications.
5050

5151

5252
## Metric totals
@@ -92,6 +92,6 @@ In addition, you can select the granularity for each graph:
9292
The X-axis charts the time based on the granularity, and the Y-axis charts the time in hours. The number shown on the top right is the average number of hours between the previous deployment and rollback for the same application.
9393

9494
## Related articles
95-
[GitOps Overview dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard)
95+
[Home Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard)
9696
[Monitoring applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/)
9797

0 commit comments

Comments
 (0)