[TechDocs] Implement a DefaultTechDocsCollator
See original GitHub issueWhat / why
In #4438, we introduced the concept of a Search collator, which is a class that a plugin can export whose purpose is to return all indexable documents the plugin is responsible for.  We should  implement a DefaultTechDocsCollator which returns documents representing individual TechDocs pages across every known TechDocs site.
Possible Implementation
- Iterate through the software catalog, looking for TechDocs annotated entities.
- The basis for the aggregated index should be the lunr index that is generated for us by mkdocs (e.g. the docskey here)
- The locationfield will need to configurable (recommend following the pattern in DefaultCatalogCollator
- Capture other potential metadata beyond the given title,textfields (like entity name/kind/namespace, etc.)
Issue Analytics
- State:
- Created 3 years ago
- Reactions:13
- Comments:10 (5 by maintainers)
 Top Results From Across the Web
Top Results From Across the Web
DefaultTechDocsCollator · Backstage Software Catalog and ...
A search collator responsible for gathering and transforming TechDocs documents. Signature: class DefaultTechDocsCollator ...
Read more >Techdocs Context Search returns no results with ... - GitHub
The TechDocs context search is enabled by default and would like to have it working ... namespace and name in DefaultTechDocsCollator #7800.
Read more >Setting up Backstage.io on Azure App Services with Github ...
Basically run npx @backstage/create-app from the root of your new ... name = "${local.name_prefix}techdocs" ... collation = "en-US".
Read more >Install Clarity - TechDocs
CREATE USER <ppm> IDENTIFIED BY <ppm> DEFAULT TABLESPACE ... to another collation, create a new SQL Server instance with the correct ...
Read more >Setting up Techdocs on Backstage | Let's Treat Docs Like Code
Software templates - This feature allows you to create templates or skeletons of code. These templates are published to GitHub. Plugins - Allow ......
Read more > Top Related Medium Post
Top Related Medium Post
No results found
 Top Related StackOverflow Question
Top Related StackOverflow Question
No results found
 Troubleshoot Live Code
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free Top Related Reddit Thread
Top Related Reddit Thread
No results found
 Top Related Hackernoon Post
Top Related Hackernoon Post
No results found
 Top Related Tweet
Top Related Tweet
No results found
 Top Related Dev.to Post
Top Related Dev.to Post
No results found
 Top Related Hashnode Post
Top Related Hashnode Post
No results found

I could grab this and start chipping away to bring the search to docs as well. I’ll start crafting types and shapes, open up a PR on those and we can then iterate from there with the implementation and tests to surround rest of the logic.
@iamEAP Just FYI, Roadie (primarily Xantier) are planning on driving through the whole TechDocs/ElasticSearch implementation to completion. This is step 1 but we are hoping to get them all done.