GitHub disables search indexing on its wiki pages because abuse negatively affects its ranking otherwise. Would it be possible to create a GitHub Pages or host a website for the wiki? I’ve found it infuriating to search Google for solutions while the answers in the wiki are not displayed. Now that I know this, this is not a problem for me. I’d imagine there are enough other Vaultwarden users though, who use Google to search for guides or solutions and struggle to find anything useful.
That will take away the ease of the whole wiki and another burden on maintaining.
Have you checked the GitHub search it self? Wiki search results · GitHub
Would it not be possible to convert the markdown files from the wiki automatically when you deploy the pages? I believe that shouldn’t be that hard since many pages templates (and custom solutions) support markdown when building the site. I believe once you’ve configured a solution like that the workflow would stay exactly the same and the website gets compiled by a github worker. I haven’t checked github search, but even if it returns the results it doesn’t fix the problem that many people will probably default to google and have a hard trouble finding things.
As I said I do not have a problem anymore, I can just go to github now that I know it and search the repo. This is about the general usability for other people who are not aware that you cannot use google to find results from the wiki.
We do not deploy the pages.
There might possibly be some way to do it. But i think the search from GitHub it self would suite just fine
The problem is that users will not think to themselves “I’ve got a Vaultwarden question, I’ll use GitHub search” but they’ll default to Google and not find the relevant information.
I know that you currently do not deploy any pages, this is what this thread is for. I wanted to make you aware of this problem I had and that I think others will also encounter and ask if creating a GitHub pages would be a possibility. It’s all hosted by GitHub so once set up properly it should be no extra cost and no extra maintenance effort.
If you don’t want to put the resources in to find a solution to allow google search indexing for your wiki that’s totally fine of course, Vaultwarden is your project after all. I just believe it would be an inconvenience to Vaultwardens userbase.
To be fair, we point to our repo in several places.
And we seem to be just fine the past 6+ years.
I’m aware of GitHub pages.
But creating something which keeps the wiki from GitHub in sync etc etc does take extra burden and checking.
And I rather invest that time in Vaultwarden it self.
1 Like