spring-projects / spring-projects/spring-security
Set unique values for docsearch version_rank
Open
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
Right now the latest version is ranked highest, but we could improve this so that other versions are ranked properly too. See https://github.com/spring-projects/spring-security/blob/ac8e3f68105073d2714df629619ad559aec3e1cf/.github/actions/docsearch-config.json.hbs#L10
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/actions/docsearch-config.json.hbs at line 10 and inspect how version_rank is currently generated for the latest version. Define ranking values for the other versions and verify the generated DocSearch configuration assigns the intended unique ranks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- handlebars
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100