Skip to content

"Search through GitLab" could be improved

Problem to solve

The Search through GitLab document provides valuable information for anyone wanting to search their instance. However, I think the structure of the content could be improved.

Proposal

  • Add to the top of the document a list of items that can be searched, each of which link to the relevant sections.
  • Consider moving the content about using the links to your assigned issues, and merge requests. Although they provide easy access to search results, I don't think of them as search.
  • Add to the document a brief guide on search criteria, that apply to all search fields. I think that would allow each section to be more compact, but still provide the reader with the required information.
  • Reword the items in the Advanced section. It's not clear from the titles that one refers to searching the content of a repository, and the other refers to search syntax.
    • Consider moving the "Advanced Syntax Search" item to the new section on search syntax.
  • Change the title of the "Advanced Syntax Search" item to "Advanced Search Syntax", as I think that is more informative, and matches the layout of the link and the content it links to.
  • Searching docs.gitlab.com for the term "search" results in this content being last on the list. I don't know what can be done in terms of SEO, but this content should be the first hit.