spring-projects / spring-projects/spring-security

Consider current version of the documentation when weighting search results

Open
#11,279 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

This is somewhat related to https://github.com/spring-projects/spring-security/issues/11056.

When there are multiple hits for the same section in different versions of the documentation, I wonder if they could be weighted based on the version of the documentation that I am searching from. For example, https://docs.spring.io/spring-security/reference/ is currently serving the documentation for Spring Security 5.7.1 so results in the 5.7.1 docs are likely to be what I am looking for. If I search for "Testing", I'm shown 10 results. Based on experience with other search engines, I'd assume that the first result is considered to be the best but it's for the 5.7.0 docs: https://docs.spring.io/spring-security/reference/5.7.0/servlet/test/index.html#page-title.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by tracing the documentation search from the 5.7.1 reference site and compare the ranking for “Testing” across the 5.7.1 and 5.7.0 documentation; done means results from the current documentation version receive appropriate weighting.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.