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

Create robots.txt #48

Merged
merged 2 commits into from
May 24, 2021
Merged

Create robots.txt #48

merged 2 commits into from
May 24, 2021

Conversation

odow
Copy link
Member

@odow odow commented May 20, 2021

Here are the subdirectories: https://github.com/jump-dev/JuMP.jl/tree/gh-pages

If I understand robots.txt correctly, it seems we really just want the stable builds being indexed?

x-ref: jump-dev/JuMP.jl#2606 (comment)

Copy link
Member

@mlubin mlubin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually use versioned links, right? If links to stable docs don't appear anywhere, then will it be hard to get them to appear in searches? (This is just speculation, not based on any insider knowledge.)

robots.txt Outdated Show resolved Hide resolved
@odow
Copy link
Member Author

odow commented May 20, 2021

This is just speculation, not based on any insider knowledge.

I thought PageRank was old news, but that could be a concern. Although the alternative is to constantly have to build up new links to x.y.z to ensure the most recent version stays popular which is also hard?

It seems better to focus our attention into a single, long-term documentation link like https://jump.dev/JuMP.jl/stable, rather than splitting it into version-specific ones, each with less traffic.

@odow
Copy link
Member Author

odow commented May 20, 2021

Did some digging on the Documenter side.

It seems to be just use robots.txt, or we could use noindex tag to force remove the old documentation:
JuliaDocs/Documenter.jl#1133
JuliaDocs/Documenter.jl#1302

I see there's also this very recent PR which adds a warning to the out-dated docs which would also help:
JuliaDocs/Documenter.jl#1577

@mlubin
Copy link
Member

mlubin commented May 20, 2021

It seems better to focus our attention into a single, long-term documentation link like https://jump.dev/JuMP.jl/stable, rather than splitting it into version-specific ones, each with less traffic.

https://jump.dev/JuMP.jl/stable is fine, but links to subsections are labels within "stable" will just break over time, which is worse than not showing up in search results.

The warning banner doesn't address the issue of search results. We had banners on old JuMP docs for a long time, and that didn't prevent them from ranking high in search results.

I'm not familiar with sitemaps but that seems potentially useful.

@odow
Copy link
Member Author

odow commented May 20, 2021

The warning banner doesn't address the issue of search results.

No. But at least it would reduce the confusion of things like jump-dev/JuMP.jl#2606 (comment)

From https://developers.google.com/search/docs/advanced/robots/intro
image
So we should continue linking to specific versions.

It's also an argument for jump-dev/JuMP.jl#2522. Then we don't have a problem linking between JuMP and MOI.

I'm not familiar with sitemaps but that seems potentially useful.

JuliaDocs/Documenter.jl#1135

@odow
Copy link
Member Author

odow commented May 24, 2021

Bump. Any more thoughts?

@odow odow merged commit ea0221e into master May 24, 2021
@odow odow deleted the odow-patch-1 branch May 24, 2021 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants