Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Refresh search index after pages have been (re)moved #2013
Gluster uses RTD to host it's documentation. We noticed that search results points to old pages that have been removed or moved. How can the search index be rebuilt to reflect actual pages in repo ?
The results of the above search query contains links that are dead because pages have been removed.
@agjohnson If I understand correctly, the part of code that should update the index is broken (bug) and the nuclear option to rebuild the index from scratch is an enhancement (workaround for the bug) targeted for the future ?
Search is very important to users and documents keep changing all the time and index should reflect it, at least eventually if rebuilding index is an expensive backend operation.
The index is updated as expected -- that is, all updated files get updated in the search index -- but we need to make some effort to detect deleted files in the repo and remove them from the index. This is a missing feature currently.
I say rebuild the index, but I meant wiping the index of the project + version build, and updating the index with the new build. This might be the most resilient way around this, deletion deletion might be hard to ensure.
There seems to be code to do this here:
Along with a TODO that indicates it's untested. But my reading is that
Any tips on how I can help getting this working correctly?
Hi all, any update on this ?
Search is a very important functionality to all gluster users. We've had users (recently by @monotek) repeatably bring this up.
We're even contemplating converting all our docs from markdown to .rst to get rid of mkdocs and use sphinx which I believe has search built in. But this conversion is a humongous task that will need manual inspection despite tools available for such conversion.
RTD has been working well for GlusterFS mini-project libgfapi-python which uses .rst and sphinx.
It would really be helpful if an estimate can be provided when the broken search can be fixed or if it'll be fixed at all.