Lightning-AI / Lightning-AI/pytorch-lightning
Removing old (v0.9.0) documentation from search indexing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
When I search for `multi-gpu training pytorch lightning` in google, the first result turns out to be documentation for [v0.9.0](https://pytorch-lightning.readthedocs.io/en/0.9.0/multi_gpu.html) which is different from the latest documentation. It will be nice if the older versions are removed from search indexing as it will prevent confusion (In my case, v0.9.0 had different arguments for multi-gpu training compared to the latest, causing confusion). I presume there must be something like [noindex](https://developers.google.com/search/docs/crawling-indexing/block-indexing) which when setup, prevents the page from getting indexed.
cc @borda
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 by inspecting how the v0.9.0 Read the Docs pages are published and whether their HTML can receive noindex metadata. Done means old-version pages no longer appear in search indexing while the latest documentation remains available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- pytorch
- Domain
- documentation, search
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100