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

Search: allow to boost pages using keywords #8670

Open
stsewd opened this issue Nov 11, 2021 · 3 comments
Open

Search: allow to boost pages using keywords #8670

stsewd opened this issue Nov 11, 2021 · 3 comments
Labels
Feature New feature Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented Nov 11, 2021

Currently we allow defining the priority on pages https://docs.readthedocs.io/en/stable/config-file/v2.html#search-ranking via a numeric value. But would be also great to define a set of keywords a page will match (that aren't necessarily included in the document).

On ES we can do something like this to support it https://www.elastic.co/guide/en/elasticsearch/reference/current/array.html.

The other thing is defining the source of those keywords, it can be from the html keywords meta-tag or from the config file (like we do with ranking and ignoring).

Sphinx uses meta-tags as source

Also, Sphinx will add the keywords as specified in the meta directive to the search index. Thereby, the lang attribute of the meta element is considered.

ref https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#html-metadata
#7082 (comment)

Looks like google and other search engines ignore/penalize using the keywords meta-tag now

Google hasn’t used meta keywords for rankings since 2009

Bing went one step further in 2011 when they announced they use the tag as a spam signal.

https://ahrefs.com/blog/seo-meta-tags/#meta-keywords

So probably better to use the config file? I think it's also more explicit, but I can also see it as duplication.

Related #7217

@stsewd stsewd added Feature New feature Needed: design decision A core team decision is required labels Nov 11, 2021
@stsewd
Copy link
Member Author

stsewd commented Nov 11, 2021

Also, didn't find something like this on algolia (like an explicit configuration)

@humitos
Copy link
Member

humitos commented Sep 15, 2023

I'm not convinced this is a good feature and probably it just adds confusion to users instead. I image searching for keyword and clicking on the first result. Then, while reading the page I realize that keyword is not present in the page at all.

I think it makes sense Google's decision to penalize this behavior. In my opinion, it's counter intuitive for users and, in the end, bad UX. I would not implement this feature.

@mhilbrunner
Copy link

I think it makes sense Google's decision to penalize this behavior

Google needs to handle the content being gamed by malicious third parties, whereas for RTD, the content authors are trusted. Being able to boost pages for some keywords would be useful so people would not have to "SEO"-optimize content for RTD's search. Being able to at least manually optimize the results for the top queries would be nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

3 participants