Skip to content

Update docs related to the search bar#24515

Merged
gzdunek merged 10 commits intomasterfrom
gzdunek/search-bar-docs
May 8, 2023
Merged

Update docs related to the search bar#24515
gzdunek merged 10 commits intomasterfrom
gzdunek/search-bar-docs

Conversation

@gzdunek
Copy link
Copy Markdown
Contributor

@gzdunek gzdunek commented Apr 13, 2023

Update for docs as now we have the search bar instead of the command bar.

Added:

  • New screenshots
  • Mention More Options additional actions button/menu in the UI section
  • New open search bar shortcut (replaces open command bar)
  • New open terminal tab shortcut.

@gzdunek gzdunek requested a review from ravicious April 13, 2023 09:20
Copy link
Copy Markdown
Member

@ravicious ravicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to sort out the more options menu situation which will probably require more changes in the doc, but the rest of the proposed changes looks good.

Trusted Clusters and there are leaf clusters connected to the root cluster. It lets you browse
leaf cluster resources. It also changes which cluster the commands in the command bar are going to target.
leaf cluster resources.
- The **more options menu** (to the left of the profile selector), containing options such as
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk, I feel like we cannot refer to it as "the more options menu" because it looks terrible in text. For example, when talking about the cluster selector I'd like to add this text:

It also changes which cluster the local terminal tabs opened through "Open new terminal" from the more options menu are going to be bound to.

I searched through some old Apple docs, e.g. https://web.archive.org/web/20150818000225/https://support.apple.com/en-us/HT204839, and it looks like in their UI the More Options icon is always referred to in the context of another specific part of the UI.

FWIW, these are not options, each item refers to an action. But even if we call it "more actions" then "more actions menu" still looks bad.

What about renaming it to something like "additional actions menu"? Instead of saying "click the More Options icon" we'd say "open the additional actions menu" and then the user can refer to this section of the docs to understand what the "additional actions menu" is.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong opinion on it, but I think this rename makes sense 👍

- The **search bar** (in the middle), which allows you to search for resources across clusters.
- The **cluster selector** (to the left of the search bar), which shows up only if you have set up
Trusted Clusters and there are leaf clusters connected to the root cluster. It lets you browse
leaf cluster resources. It also changes which cluster the commands in the command bar are going to target.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this:

Also, the "Open new terminal" action will bound new terminal tabs to the selected cluster.

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
gzdunek and others added 3 commits May 5, 2023 16:35
Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
# Conflicts:
#	docs/pages/connect-your-client/teleport-connect.mdx
Comment thread docs/img/use-teleport/connect-cluster.png
@public-teleport-github-review-bot public-teleport-github-review-bot Bot removed the request for review from kimlisa May 5, 2023 21:32
Copy link
Copy Markdown
Member

@ravicious ravicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Submitted some minor suggestions.

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
@gzdunek gzdunek enabled auto-merge May 8, 2023 10:47
@gzdunek gzdunek added this pull request to the merge queue May 8, 2023
Merged via the queue into master with commit ef0cb91 May 8, 2023
@gzdunek gzdunek deleted the gzdunek/search-bar-docs branch May 8, 2023 11:05
@public-teleport-github-review-bot
Copy link
Copy Markdown

@gzdunek See the table below for backport results.

Branch Result
branch/v13 Failed

gzdunek added a commit that referenced this pull request May 8, 2023
* Update docs related to the search bar

* Rename "more options menu" to "additional actions menu"

* Inform that terminal tabs are bound to the selected cluster

* Apply suggestions from code review

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* Update screenshots

* Crop app screenshots

* optimize images

* Apply @ravicious suggestions

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
(cherry picked from commit ef0cb91)
gzdunek added a commit that referenced this pull request May 8, 2023
* Update docs related to the search bar

* Rename "more options menu" to "additional actions menu"

* Inform that terminal tabs are bound to the selected cluster

* Apply suggestions from code review

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* Update screenshots

* Crop app screenshots

* optimize images

* Apply @ravicious suggestions

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
(cherry picked from commit ef0cb91)
@r0mant r0mant mentioned this pull request Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants