Skip to content

Commit 40ca158

Browse files
authored
Command bar (#686)
* Add new topic for quick search Added content and screenshots for new quick search * Update command-bar.md add related article link * Update nav.yml Added command bar to nav bar * Update command-bar.md Added header to topic * Update quick-search-options.png * Move quick search bucket Moved command bar topic to intro bucket and added it to home yaml * Update command-bar.md Content edits * Add note on handshake Added note on handshake request in on-prem environments; changed title to Universal Search & Navigation * Update command-bar.md * Add enable new codefresh experience Added how to enable new codefresh experience as new topic and in command bar; change title of command bar to Global * Add keyboard shortcuts for global Added table with keyboard shortcuts to global search * Update command-bar.md * Update command-bar.md * Update enable new experience Fixed instructions for enabling new experience and switch back to Classic * Update command-bar.md Removed section on enabling new experience and added link * Update xrefs and screenshot * Update enable-new-experience.md * Update nav.yml
1 parent b1f17bd commit 40ca158

File tree

9 files changed

+144
-3
lines changed

9 files changed

+144
-3
lines changed

_data/home-content.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
localurl: /docs/getting-started/gitops-codefresh/
1414
- title: Concepts in Codefresh
1515
localurl: /docs/getting-started/concepts/
16-
16+
- title: Global Search & Navigation
17+
localurl: /docs/getting-started/command-bar/
1718

1819
- title: Quick starts
1920
icon: images/home-icons/tutorial.svg

_data/nav.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
url: "/gitops-codefresh"
1313
- title: Concepts in Codefresh
1414
url: "/concepts"
15+
- title: Global Search & Navigation
16+
url: "/command-bar"
1517

1618

1719
- title: Quick starts
@@ -529,7 +531,7 @@
529531

530532
- title: Administration
531533
url: "/administration"
532-
pages:
534+
pages:
533535
- title: Account & user management
534536
sub-pages:
535537
- title: Create a Codefresh account
@@ -607,9 +609,11 @@
607609
- title: On-premises
608610
url: "/on-prem-release-notes"
609611

610-
- title: New Codefresh
612+
- title: Codefresh New Experience
611613
url: "/new-codefresh"
612614
pages:
615+
- title: The Codefresh New Experience
616+
url: "/enable-new-experience"
613617
- title: Navigation quick reference
614618
url: "/menu-navigation"
615619
- title: Documentation changes

_docs/getting-started/command-bar.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: "Global Search & Navigation"
3+
description: "How to perform actions, search for entities, find features, and more with Global Search & Navigation"
4+
group: getting-started
5+
toc: true
6+
---
7+
8+
9+
10+
Stay where you are in Codefresh and get to what you want without extra clicks! Be it navigation, actions such as switching accounts, or finding entities such as pipelines or builds, Codefresh Global Search & Navigation is your answer.
11+
12+
13+
14+
15+
16+
## About Global Search & Navigation
17+
18+
Global Search & Navigation is always available in the toolbar, displayed on the top-left.
19+
20+
> **TIP**:
21+
If you don't see it, you may have to [enable the Codefresh New Experience]({{site.baseurl}}/docs/new-codefresh/enable-new-experience/#enable-the-codefresh-new-experience).
22+
23+
When you click the Global Search field, you can see the predefined categories to jump-start your search for **Pipelines** **Projects**, or **Documentation**.
24+
25+
To start the search, click a category or directly type in the first letters of what you're looking for.
26+
Select the option or use the shortcut keys. See [Keyboard shortcuts for Global Search & Navigation](#keyboard-shortcuts-for-global-search--navigation).
27+
28+
>**TIP**:
29+
The results are synced to your permissions and account settings.
30+
31+
32+
{% include
33+
image.html
34+
lightbox="true"
35+
file="/images/administration/command-bar/quick-search-options.png"
36+
url="/images/administration/command-bar/quick-search-options.png"
37+
alt="Global Search & Navigation in Codefresh"
38+
caption="Global Search & Navigation in Codefresh"
39+
max-width="60%"
40+
%}
41+
42+
43+
We are always adding more options, so stay tuned to our online announcements.
44+
45+
>**NOTE**:
46+
>The Global Search & Navigation feature establishes an initial handshake request with the data source API on inital loading. The outcome of this request does not impact functionality, even in on-premises or air-gapped environments where it will fail.
47+
>Although your monitoring or alerting systems may flag it as a failure, you can safely disregard the failure notification.
48+
49+
## Keyboard shortcuts for Global Search & Navigation
50+
51+
Here are a few keyboard shortcuts to work with Global Search & Navigation.
52+
53+
{: .table .table-bordered .table-hover}
54+
| Navigate to | Keyboard Shortcuts |
55+
| ---------- | -------------------------- |
56+
| Global Search | **⌘+ K** |
57+
| Projects | **P** then **R** |
58+
| Builds | **B** |
59+
| Steps | **S** then **T** |
60+
| GitOps Apps | **A** then **P** |
61+
| Helm Boards | **H** then **B** |
62+
| DORA Metrics | **D** then **R** |
63+
| Images | **I** then **M** |
64+
65+
66+
## Find actions & configuration settings
67+
In addition to quickly navigating to specific entities such as Builds and Pipelines, administrators can navigate to configuration settings such as Single Sign-On, and installation actions.
68+
69+
{% include
70+
image.html
71+
lightbox="true"
72+
file="/images/administration/command-bar/quick-search-single-sign-on.png"
73+
url="/images/administration/command-bar/quick-search-single-sign-on.png"
74+
alt="Example: Finding Single Sign-On with Global Navigation & Search"
75+
caption="Example: Finding Single Sign-On with Global Navigation & Search"
76+
max-width="60%"
77+
%}
78+
79+
## Switch accounts
80+
Use Global Search & Navigation to switch between Codefresh accounts.
81+
Instead of selecting the account to sign in to from your avatar, stay where you are, and use our built-in action to switch accounts.
82+
83+
* In the Global Search field, start typing `accounts` to get to the Switch Account action.
84+
* Select **Switch Account**** to see the list of accounts, and then either select or use auto-complete to select the account.
85+
86+
{% include
87+
image.html
88+
lightbox="true"
89+
file="/images/administration/command-bar/switch-account.png"
90+
url="/images/administration/command-bar/switch-account.png"
91+
alt="Switch accounts with Global Navigation & Search"
92+
caption="Switch accounts with Global Navigation & Search"
93+
max-width="60%"
94+
%}
95+
96+
97+
98+
## Related articles
99+
[Account and user settings]({{site.baseurl}}/docs/administration/account-user-management)
100+
[Codefresh for CI]({{site.baseurl}}/docs/getting-started/ci-codefresh/)
101+
[Codefresh for CD]({{site.baseurl}}/docs/getting-started/cd-codefresh/)
102+
[Concepts in Codefresh]({{site.baseurl}}/docs/getting-started/concepts/)
103+
[Introduction to Codefresh]({{site.baseurl}}/docs/getting-started/intro-to-codefresh/)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "The Codefresh New Experience"
3+
description: "Enable the Codefresh New Experience"
4+
toc: true
5+
---
6+
7+
8+
Unveiling the Codefresh New Experience, bringing you new navigation, features, and functionality, with seamless access to both Codefresh Pipelines and Codefresh GitOps.
9+
10+
Here are a few highlights:
11+
* [Pipelines Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/#pipelines-dashboard): Our new Home dashboard includes a dedicated Pipelines Dashboard. Easily monitor pipeline metrics and performance to gain insights and optimize pipeline definitions.
12+
* [Images Dashboard]({{site.baseurl}}/docs/dashboards/images/): We have redesigned the Images dashboard with a new layout, grouping images by repository.
13+
* [Global Search & Navigation]({{site.baseurl}}/docs/getting-started/command-bar/): Quickly locate specific features or functionalities while staying where you are.
14+
* [Enhanced navigation]({{site.baseurl}}/docs/new-codefresh/menu-navigation/): Navigation options are categorized by user options (accessed by clicking your Avatar in the toolbar), account-level administration and configuration, and features and functionality.
15+
16+
17+
## Enable the Codefresh New Experience
18+
As a Codefresh admin, you can enable the Codefresh New Experience for a specific account. You also flexibility to switch back to the previous version of Codefresh at any time.
19+
20+
1. In the Codefresh UI, on the toolbar, click the **Settings** icon and then select **Account Settings**.
21+
1. From General in the sidebar, select **Account Information**.
22+
1. Click **Enable the New Experience**.
23+
24+
**To restore the previous version:**
25+
1. In the Codefresh UI, on the toolbar, click the **Settings** icon and then select **Account Settings**.
26+
1. From General in the sidebar, select **Organization Information**.
27+
1. Scroll down to **Switch to Classic Codefresh**, and click **Return to previous version**.
28+
29+
## Related articles
30+
[Codefresh for CI]({{site.baseurl}}/docs/getting-started/ci-codefresh/)
31+
[Codefresh for CD]({{site.baseurl}}/docs/getting-started/cd-codefresh/)
32+
[Concepts in Codefresh]({{site.baseurl}}/docs/getting-started/concepts/)
33+
[Introduction to Codefresh]({{site.baseurl}}/docs/getting-started/intro-to-codefresh/)
39.6 KB
Loading
50.2 KB
Loading
41.8 KB
Loading
7.35 KB
Loading
98.1 KB
Loading

0 commit comments

Comments
 (0)