Closed johnnymatthews closed 2 years ago
Pages:
Dead link checker on internal links came back with three errors. Fixes those. Links are now fine. Good to merge this one, apart from the search issue. I'm dealing with Algolia right now to try and get them to re-index the site sooner.
So the PR is ready to go. All the content has been updated, the pages have been renamed, and the links have been changed to go to the right places! But there's a problem...
The search bar is powered by Algolia, which indexes the site once a week. Indexing isn't something we can control, as far as I know anyway. I've been crawling through my emails and Algolia dashboard to see if there's anyway to prompt an early re-index, but I can't find anything.
Not being able to re-index the site is a problem because this PR moves a bunch of files around. This means that a user might be able to go to docs.filecoin.io, search for Mine, click the first result, and hit a 404. Hitting a 404 is a problem we can't control either, because VuePress handles 404 redirects client-side using funky JavaScript stuff, which loads before Algolia does - esentially, our /docs/.vuepress/public/_redirects
file won't help here.
With all that in mind, here's three solutions:
We ended up going with solution 1 - re-implement the VuePress default search.
The Filecoin project is moving away from using the term miner and replacing it with storage provider, retrieval provider, or just provider. However, we need to make sure we're not changing anything within code blocks. We need the user to know certain cases where miner refers to a direct variable, daemon, or function within a Filecoin implementation.
Tasks
/docs/.vuepress/public/redirects
.Nice to have, but not fully required
miner
in the name, and rename them to fit the naming convention.