Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
quba42 opened this issue Jul 1, 2024 · 2 comments

Comments

@quba42
Copy link

quba42 commented Jul 1, 2024

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

@quba42 quba42 changed the title When searching for Changelog, there are a dozen results that don't specify what component the result is for When searching for Changelog, th results that don't specify what component they are for Jul 1, 2024
@quba42 quba42 changed the title When searching for Changelog, th results that don't specify what component they are for When searching for Changelog, the results that don't specify what component they are for Jul 1, 2024
@quba42 quba42 changed the title When searching for Changelog, the results that don't specify what component they are for When searching for Changelog, the results don't specify what component they are for Jul 1, 2024
@pedro-psb
Copy link
Member

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
Copy link
Author

quba42 commented Jul 1, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants