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

Remove legacy documentation from search #1434

Open
LFISHER7 opened this issue Feb 6, 2024 · 2 comments
Open

Remove legacy documentation from search #1434

LFISHER7 opened this issue Feb 6, 2024 · 2 comments

Comments

@LFISHER7
Copy link
Contributor

LFISHER7 commented Feb 6, 2024

There is legacy documentation relating to cohort extractor (e.g. https://docs.opensafely.org/study-def/) that has some overlap with other content. Both appear in search results, which can be confusing (see this slack thread).

We could maintain the legacy documentation but remove it from search results using this mkdocs plugin.

@StevenMaude
Copy link
Contributor

StevenMaude commented Feb 6, 2024

So looking around, it is possible to remove the pages from search results in Material for MkDocs by editing the page itself:

https://squidfunk.github.io/mkdocs-material/plugins/search/#meta.search.exclude

The plugin that Louis linked maybe makes it a bit more obvious in the configuration that a subset of pages are excluded. But if we only have the eight pages of the "Legacy" section to exclude, so maybe it's OK to do that per page, rather than add another plugin.

(I guess there's an associated question of: do we want to remove these results from search engines. But I think probably not.)

@lucyb
Copy link
Contributor

lucyb commented Feb 20, 2024

Because this refers to Cohort Extractor, I'm putting this into Team RAP's triage list for them to look at.

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

3 participants