Find a better way to show search results for page with same titles from different clouds

[fharper]

What type of suggestions?

Unclear Information

What page is concerned?

No response

What version of the docs?

No response

What is the issue?

Since most clouds have the same information with some variant in the docs, the search results may seems like it's showing duplicating content, when in fact, it's not.

All Deprovision result in the previous screenshot is a different page from a different cloud. To prevent this "issue", I renamed some of the pages headers to be cloud specific, as shown in the following screenshot.

I don't think it's the solution anymore, and we would need to do this to a lot more pages, and mostly all headers in all pages. It will make the docs harder to read, and less friendly.

I need to investigate Typesense a bit more to see if I can group docs per cloud (maybe different collections).

Code of Conduct

• I agree to follow this project's Code of Conduct

[patrickdappollonio]

I think this is not only true for the built-in search but also for Google:

[fharper]

Oh, you're right, so fixing TypeSense result won't fix search engines'. Could be a first step anyway...

It's why I was against duplicating content like that in the first place (even if it's imports and not really duplicated, but shown multiples times) when Jared did the refactor with MDX during a weekend. Instead my idea was to have different pages when content is too different (which we already do for k3d install vs any other clouds), have the docs written in a way that it doesn't matter which cloud you are looking at for most things, and tabs for the small places where it's too different. Anyway, I couldn't make us change route, so I'll try to find a proper way to fix this with the architecture that was choosen.

[patrickdappollonio]

That makes sense. I haven't used mdx but mkdocs-material has a way of creating tabbed content within sections of the page, and each tab as long as they have the same name will update all tabs in that page.

It's pretty nifty for when most of the content is the same but you still want people to have an experience specific to a particular tool.