Skip to content

Commit

Permalink
Update search docs to use Command Palette (jenkins-infra#7876)
Browse files Browse the repository at this point in the history
* Updating search documentation for Command Palette

* compressed images

* incorporate docs review suggestions

---------

Co-authored-by: Kris Stern <[email protected]>
  • Loading branch information
kmartens27 and krisstern authored Feb 14, 2025
1 parent 240fcc5 commit 80ad271
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 18 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/doc/book/resources/using/search/box.png
Binary file not shown.
Binary file not shown.
Binary file removed content/doc/book/resources/using/search/dropdown.png
Binary file not shown.
37 changes: 19 additions & 18 deletions content/doc/book/using/searchbox.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: section
title: Search Box
title: Command Palette
---
ifdef::backend-html5[]
:description:
Expand All @@ -12,45 +12,46 @@ ifdef::backend-html5[]
endif::[]


= Using Search Box
= Using Command Palette

Every page in Jenkins has a search box on its top right that lets you get to your destination quickly, without multiple clicks.
Jenkins now features a new search experience known as *Command Palette*.
Located in the upper-right corner of the page next to your name, the Command Palette enables you to search everything in Jenkins.

[.boxshadow]
image:using/search/box.png[image]
image:using/command-palette/search-icon.png[Updated search icon from Command Palette.]

For example, if you type "foo #53 console", you'll be taken to the console output page of the "foo" job build #53.
If you have "XYZ" view, just type "XYZ" to get to that view.
The search box comes with auto-completion to assist you.
For example, enter "git #23 console" to display the results for the console output page of "git job build #23".
The Command Palette feature utilizes auto-completion to help you find what you're looking for.
Results can include additional search terms for narrowing results, Pipelines, Views, additional features installed within your Jenkins environment, such as the Design Library, and specific pages within jobs based on your installed plugins, such as the plugin:warnings-ng[Warnings] plugin.
Search results also provide more clarity in the form of icons to help indicate Jenkins features and job statuses.

[.boxshadow]
image:using/search/dropdown.png[image]
The Command Palette is also accessible via keyboard commands for macOS (`CMD+k`) and Windows/Linux (`CTRL+K`).

The search box is also context sensitive.
If you are already somewhere in the foo job (perhaps you are looking at another build), then you can just type "#53 console" instead of "foo #53 console".
If you are already somewhere in the foo #53 (maybe you are looking at test report), then you can just type "console" to get to the same page.
[.boxshadow]
image:using/command-palette/auto-complete-results.png[Auto-complete results from typing into the Command Palette.]

[[SearchBox-Caseinsensitivesearch]]
=== Case insensitive search

If you want the search box to be case insensitive, go to your profile configuration page (/jenkins/user/<your profile>/configure) and activate the case insensitive search option.
Navigate to your profile preferences page (/jenkins/user/<your_profile>/preferences) and activate the case- insensitive search option, if desired.

[.boxshadow]
image:using/search/case-sensitivity.png[image]
image:using/command-palette/case-sensitivity.png[Case insensitivity checkbox in user preferences.]

Please note that case-insensitive search is not available for anonymous (not logged in) users.
Please note that case-insensitive search is not available for anonymous (not signed in) users.

[[SearchBox-OpenSearchsupport]]
=== OpenSearch support

This search box feature is also exposed to the browser through http://en.wikipedia.org/wiki/OpenSearch[OpenSearch], so you can install this search and auto-completion feature to your browser search box. This would further reduce the overhead it takes for you to visit a particular page in Jenkins.
This search feature is also exposed to the browser through http://en.wikipedia.org/wiki/OpenSearch[OpenSearch], so you can install this search and auto-completion feature in your browser search box, making it even easier to navigate Jenkins.

For example in Firefox, you can add the Jenkins search to your browser's search engines via the dropdown on the right of the address bar:

[.boxshadow]
image:using/search/add-to-firefox.png[image]
image:using/command-palette/add-to-firefox.png[image]

[[SearchBox-Feedbackappreciated]]
=== Feedback appreciated

There's always a room for improvements in how Jenkins associates search terms with actual pages. Your feedback is appreciated.
There's always room for improvement in how Jenkins associates search terms with actual pages.
Your feedback is appreciated.

0 comments on commit 80ad271

Please sign in to comment.