Repository navigation
docs(user-guide): add Search Your Templates for the templates search box - #880
Draft
danielfsousa wants to merge 2 commits into
Draft
danielfsousa wants to merge 2 commits into
danielfsousa wants to merge 2 commits into
Conversation
The new Templates page searches through the Search API, so its box takes words, filters, OR, negation, quotes and dates. The article covers what you can type, what the Status filter, sort, paging, per-page and Save as CSV controls do, and sharing a search by its URL. Refs SparkPost/email-monorepo#964
✅ Deploy Preview for support-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Three screenshots of the new Templates page on tst: a search with its results, the Status filter writing status:published into the box, and the table's sort, paging and per-page controls. Refs SparkPost/email-monorepo#964
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs SparkPost/email-monorepo#964. Refs SparkPost/email-monorepo#961, the templates page. Refs SparkPost/email-monorepo#948, the epic.
Important
Do not merge before production phase 3 starts. The article publishes at the start of phase 3, before the API pages in SparkPost/developers.sparkpost.com#598. It stays a draft until then.
Summary
The new Templates page searches every template in an account, and no support article says how to use its box. This PR adds a user-guide article, Search Your Templates, written in the style of Stripe's dashboard search page and GitHub's guide to filtering issues. It covers what you can type, what the controls do, and how to share a search. It leaves out the grammar's internals.
Changes
content/docs/user-guide/searching-templates.mdhas sections to search for a template, filter by status, sort and page through results, and share a search. Then come named examples, a syntax table, a table of the fields you can search, and a link to the API's Search page.content/docs/user-guide/media/searching-templates/holds three screenshots, embedded in the article.Choices worth knowing
main, not spec section 14, where the two differ. The Status dropdown writesstatus:…into the box. Sort is Last Updated only. There is no last-page control and no subaccount dropdown. A shared URL holds the search and the sort, so it opens on page 1.query.Parse, and the error it quotes,AND needs a term after it, is the service's real message.Screenshots
Taken from the new Templates page on tst on 2026-11-09. They're cropped below Recent Activity, so only generic system and test templates are in frame. They live in
content/docs/user-guide/media/searching-templates/:templates-search-results.pngpaymentin the box, with three matching templatestemplates-status-filter.pngpayment status:publishedin the boxtemplates-search-controls.pngstatus:publishedat 10 per page, with the paging arrows, the per-page buttons and Save As CSVThere's no screenshot of the address bar, because the capture tool records only the page, not the browser's toolbar. The Share a search section is text only.
Proof
Run locally on 2026-11-09 at commit
49f69ae3.query.Parseinsearch-apiwelcome ANDfails withAND needs a term after itnext dev, Node 16.18next buildand the Cypress testsVerification
/docs/user-guide/searching-templates/.