search

pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.
https://pedro-psb.github.io/pulp-docs/
2 stars 3 forks source link

When searching for Changelog, the results don't specify what component they are for #62

Open quba42 opened 2 weeks ago

quba42 commented 2 weeks ago

We need to make it so that when searching for "Changelog" I can tell what component each "Changelog" in the list of results is for.

Since changelogs are auto-generated, this could probably be handled via the plugin_template?

The following screenshot illustrates the problem:

pulp_changelog_naming

pedro-psb commented 2 weeks ago

I am able to do some hack on pulp-docs itself (lets say, change the titles to {plugin} Changelog before building), since it has programmatic access to all files. Of course the original files would remain untouched, but this is only a problem on the context of the website anyway.

Another option is wait mkdocs-material release their new search engine. Its a big epic and among the items there is a feature addressing exactly this problem. I know its being worked on because recently I've seen some tech preview PRs of the author asking for feedback.

quba42 commented 2 weeks ago

Ok, if the upstream search project is working on this exact problem (they even used "Changelog" as their example!) I am tempted to say we wait for that, even if it may take some time to land.