Skip to content

Docs: standardize descriptions of search functions

Amy Qualls requested to merge 217567-fix-definitions into master

What does this MR do?

Updates the search descriptions on the following pages to be consistent:

  1. https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/resolvers/issues_resolver.rb#L47
  2. https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/resolvers/environments_resolver.rb#L11
  3. https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/types/error_tracking/sentry_error_collection_type.rb#L20
  4. https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/resolvers/projects_resolver.rb#L13
  5. https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/graphql/resolvers/epics_resolver.rb#L21
  6. https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/graphql/resolvers/requirements_management/requirements_resolver.rb#L20

Previously, they were:

  • Epic: 'Filter epics by title and description'
  • Environment: 'Search query'
  • Issue: 'Search query for finding issues by title or description'
  • Project: 'Search criteria'
  • SentryErrorCollection: 'Search term for the Sentry error.'
  • Requirements: 'Filter requirement by title'

Related issues

Related to #224130 (closed)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Craig Norris

Merge request reports