Skip to content

docs: add search query language reference

Administrator requested to merge rvt/search-docs-railroad into master

Created by: rvantonder

This PR:

  • adds a query language reference page using railroad diagrams and examples
  • updates links and syntax for structural search
  • removes some terms like 'token', and propagates use of 'parameter' consistently. Terms are basically consistent with RFC 184.

Based on slack feedback I have updated the reference page to:

  • Re @mrnugget feedback, I greatly simplified the notion of expression/operator and nesting, and basic queries in the diagrams. It is much more intuitive now.
  • Re @attfarhan @mrnugget feedback, include our existing examples (synonymous with the queries.md table format)
  • Re @mrnugget feedback, using em-dash to make the negation/minus filter more obvious, and in examples.

It's in a good state and overall this page adds value rather than detracts from anything, so I don't think the reviewer needs to see what the changes look like to approve (we can iterate on subsequent PRs), but if the reviewer insists, go to http://c0412a12180a.ngrok.io/user/search/language

Merge request reports