Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: "Migration from VuePress" and "Migration from VitePress 0.x" not discoverable by search #4369

Open
4 tasks done
olets opened this issue Nov 20, 2024 · 2 comments
Open
4 tasks done
Labels
docs Improvements or additions to documentation

Comments

@olets
Copy link
Contributor

olets commented Nov 20, 2024

Describe the bug

In Bing, DuckDuckGo, Ghostery Search, and Google, my top result for "migrate from vuepress to vitepress" is https://vitepress.dev/guide/migration-from-vuepress

I only used a search engine after searching the VuePress and VitePress docs and getting nothing.

Looking at the source, I see there's also https://vitepress.dev/guide/migration-from-vitepress-0

Reproduction

Search for "migration" in the VitePress docs. See that there are no results.

Expected behavior

Searching for "migration" in the VitePress docs finds the VuePress guide and the VitePress 0.x guide.

System Info

n/a

Additional context

If these pages were meant to be retired, they could get a "not actively maintained" notice at the top. The fact that they don't turn up in search, and that I haven't found anything in the source saying "exclude these pages from search", makes me wonder if the VitePress docs' search is buggy, and whether that means my VitePress sites' search is buggy.

Validations

@olets olets added the bug: pending triage Maybe a bug, waiting for confirmation label Nov 20, 2024
@brc-dd
Copy link
Member

brc-dd commented Nov 20, 2024

and that I haven't found anything in the source saying "exclude these pages from search",

Those files are intentionally removed from sitemap and have no direct link from any content or sidebar/navbar, that's why algolia's crawler can't find them.

sitemap: {
hostname: 'https://vitepress.dev',
transformItems(items) {
return items.filter((item) => !item.url.includes('migration'))
}
},

Stuff like search: false in frontmatter is only required for local search.

In Bing, DuckDuckGo, Ghostery Search, and Google, my top result for "migrate from vuepress to vitepress" is https://vitepress.dev/guide/migration-from-vuepress

This might be because of vitepress.dev's ranking and the fact that we haven't added no-index header like this:

vitepress/netlify.toml

Lines 15 to 18 in 5649071

[[headers]]
for = "/_translations/*"
[headers.values]
x-robots-tag = "noindex"

Those guides aren't useful at all. They just list 2-3 differences. Might be better to just exclude them from build.

@brc-dd brc-dd added docs Improvements or additions to documentation and removed bug: pending triage Maybe a bug, waiting for confirmation labels Nov 20, 2024
@olets
Copy link
Contributor Author

olets commented Nov 20, 2024

Thanks, makes sense.

If anyone finds this thread looking for a migration guide, I decided to write my own unofficial one: https://olets.dev/posts/migrate-from-vuepress-to-vitepress/

Will leave it up to you to close the issue — not sure if you want it left open for a decision on whether or not to cut these pages from the build.

I don't see precedent for linking community guides in the docs, but if you think mine might be useful you're welcome to link it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants