Deploy Testing Checklist
Run through this checklist before and after every deployment to catch issues early.
Pre-Deployment
-
npm run buildcompletes without errors - No unexpected broken link warnings in build output
- New pages have correct frontmatter (
sidebar_position,id,title) - New categories have
_category_.jsonfiles - New clients are registered in
src/pages/index.tsxandsrc/theme/SearchBar/index.tsx - Internal links use relative paths (not absolute route prefixes)
- No hardcoded URLs to other clients' pages
Post-Deployment
- Homepage loads and shows all client cards
- Client landing pages load (
/{client-slug}/) - Site intro pages load (
/{client-slug}/{site-slug}/intro) - Sidebar navigation works and shows correct categories
- Search returns results
- Client/site dropdown filters work in search modal
- New content appears in search results after scraping
- Meta tags present in page source (
docsearch:client_tag,docsearch:site_tag)
Common Issues
| Symptom | Cause | Fix |
|---|---|---|
| Client not appearing on homepage | Missing entry in clientList in index.tsx | Add entry or run create-new-client-site.ps1 |
| Client not in search filters | Missing entry in clientRegistry in SearchBar/index.tsx | Add entry or run create-new-client-site.ps1 |
| Sidebar shows wrong order | Missing or incorrect sidebar_position | Check frontmatter in affected files |
| Category not appearing | Missing _category_.json | Create the file in the category directory |
| Search returns no results | Scraper not run after build | Run ./typesense/scrape.sh |
| Meta tags missing from HTML | Plugin not injecting | Check docsearch-meta-plugin in docusaurus.config.ts |
| Build fails with broken links | Absolute link to old route prefix | Convert to relative path |