docs icon indicating copy to clipboard operation
docs copied to clipboard

"Advanced search syntax" page doesn't include `@me` syntax

Open kospl opened this issue 3 years ago • 5 comments

Code of Conduct

What article on docs.github.com is affected?

Searching issues and pull requests

What part(s) of the article would you like to see updated?

I would like to see a new part of searching manual related to advanced search variables, like @me.

Additional information

  1. Open issues search image

  2. Open Filters dropdown and click View advanced search syntax option image

  3. There is no information on help page about such advanced search option as commenter:@me image


Content design for changes to fix this issue

In the Searching issues and pull requests article:

  • Create a new section "Searching for my issues and pull requests" after "Search by a user that's involved in an issue or pull request" as this is the last of a series of sections about filtering on usernames.
  • Mention that you can view a list of all the issues and pull requests you created, are assigned, mentioned on, or are requested as a reviewer of (pull requests only) using the Issues and Pull requests links shown in the top menu bar when you're logged in.
  • Explain that you can use @me with any of the fields that take a username to limit your search to issues or pull requests that you have interacted with.
  • For more information, see "Understanding the search syntax"
  • Give a couple of examples, based on the examples in the sections above.

kospl avatar Aug 28 '21 12:08 kospl

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 28 '21 12:08 welcome[bot]

@kospl Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:

ramyaparimi avatar Aug 30 '21 11:08 ramyaparimi

Have a nice triage time!

kospl avatar Aug 30 '21 11:08 kospl

@kospl - thanks for raising this issue and for including detailed information about the change that you propose. 💖

It looks as if @me is mentioned in Understanding the search syntax, but I agree with you that it would be good to mention it in this article on searching issues and pull requests too.

We could add an example of using @me to every one of the search examples on this page where it's relevant. However, it might be better to add a new section "Searching for my issues and pull requests". This could cover:

  • The ability to view all the issues and pull requests you created, are assigned, mentioned on, or are requested as a reviewer of (pull requests only) using the Issues and Pull requests links shown in the top menu bar when you're logged in.
  • The option to use @me with any of the fields that take a username to limit your search to issues or pull requests that you have interacted with.
  • Position this new section after "Search by a user that's involved in an issue or pull request" as this is the last of a series of sections about filtering on usernames.

felicitymay avatar Aug 31 '21 13:08 felicitymay

@kospl - I've updated the issue summary with a content design plan based on my comment above. I'll add a help wanted label to indicate that we're looking for help fixing this issue.

felicitymay avatar Aug 31 '21 14:08 felicitymay

Hi @kospl! I've created a PR that hopefully addresses all discussed changes and closes this issue. Thx @felicitymay for the wonderful content outline!

mark-mxwl avatar Dec 01 '23 02:12 mark-mxwl