filecoin-project / filecoin-docs

Filecoin Docs
https://docs.filecoin.io
222 stars 297 forks source link

Replace "miner" with "storage provider" where possible. #1158

Closed johnnymatthews closed 2 years ago

johnnymatthews commented 2 years ago

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

Nice to have, but not fully required

johnnymatthews commented 2 years ago

Pages:

johnnymatthews commented 2 years ago

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.

johnnymatthews commented 2 years ago

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:

  1. Fall back to the default VuePress search. This is an easy fix, and will mean this PR can land today. The search is slightly more limiting, as VuePress just looks for h1, h2, and h3 headers for content. But it works.
  2. Focus on getting https://github.com/filecoin-project/filecoin-docs/pull/1162 working and cherry-pick the content updates into that. This is a decent solution, but will take a few days. Moving to the Doks theme is something that's gonna happen at some point anyway. But this solution will require a lot of my time, so Snap-deals documentation will have to sit on the back-burner until this is done.
  3. Merge this PR anyway and hope no one searches for miner in the next few days. This is the easiest solution, but has a major potential for bad UX - at least until Algolia re-indexes the site, but I don't know when that's gonna be.
johnnymatthews commented 2 years ago

We ended up going with solution 1 - re-implement the VuePress default search.