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

[Beta] Change html_root_url to point to the latest beta documentation #35307

Closed
wants to merge 1 commit into from
Closed

[Beta] Change html_root_url to point to the latest beta documentation #35307

wants to merge 1 commit into from

Conversation

FaultyRAM
Copy link

Partially addresses #30693 by changing html_root_url on all relevant crates to point to the latest beta docs instead of nightly. Fully addressing the issue would also involve updating html_root_url on stable to point to the current stable docs.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nikomatsakis (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive
Copy link
Collaborator

warning Warning warning

  • Pull requests are usually filed against the master branch for this repo, but this one is against beta. Please double check that you specified the right target!

@FaultyRAM FaultyRAM changed the title Change html_root_url to point to the latest beta documentation [Beta] Change html_root_url to point to the latest beta documentation Aug 4, 2016
@alexcrichton
Copy link
Member

Thanks for the PR! Currently we don't have an automated process for doing this, but we probably should. The failure mode here is that when you compile documentation against the standard library (the stable version) it'll link to nightly instead of that stable version. This isn't so bad, and I'd be wary of basically having to make a PR every time we make a release, could we automate this in some fashion to happen without us making PRs?

cc @brson

@brson
Copy link
Contributor

brson commented Aug 9, 2016

This does call for automation of some sort. We've discussed it before and not come to any conclusions. ISTM the only reasonable thing to do is replace this text during the build process, but there doesn't seem to be any existing machanism that will work for it.

There are other reasons to have a general facility for text replacement - the version numbers for all the crates seem to be set to "0.0.0", which is completely wrong. They should all be the same as the compiler version.

Accepting this PR won't accomplish much since it will be bogus on the stable build.

@nikomatsakis
Copy link
Contributor

r? @brson (I have no idea here)

@rust-highfive rust-highfive assigned brson and unassigned nikomatsakis Aug 10, 2016
@brson
Copy link
Contributor

brson commented Aug 12, 2016

I prefer to pursue something like #19603, so closing this, but @FaultyRAM if you wanted to purse #19603 we can probably come up with a solution.

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

Successfully merging this pull request may close these issues.

5 participants