Update docs to fix various 404s #23736
Conversation
|
r? @huonw (rust_highfive has picked a reviewer for you, use r? to override) |
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="playpen.js"></script> | ||
| <script type="text/javascript" src="/jquery.js"></script> | ||
| <script type="text/javascript" src="/playpen.js"></script> |
There was a problem hiding this comment.
this will break running locally
There was a problem hiding this comment.
Do you have any suggestions on a fix that works locally and at multiple levels in the tree? Not super familiar here.
There was a problem hiding this comment.
it's a pretty classic webdev issue. I'm not sure what the right fix is here, exactly.
There was a problem hiding this comment.
Is there any documentation on contributing to docs specifically? Is there a constraint that all links in docs should run when browsing on the local file-system? For example, it's pretty easy for a contributor to just run python -m SimpleHTTPServer in the docs directory and have absolute links work correctly.
There was a problem hiding this comment.
I'm not sure if it's explicitly documented, but that it doesn't require anything else is a source of pride and something many users find useful. Introducing a python dependency, however ubiquitous, is a pretty significant downside.
There was a problem hiding this comment.
I just dropped this file from the diff for now to not block the other fixes. I'll look at other possibilities here.
Found a few 404s that seemed like simple fixes:
The Result docs use old_io Writer as an example. Fix the link to old_io Writer. There's probably an effort to update the example away from a deprecated api but this was a simple fix.
rustc/plugin was pointing at the old guide and it was a broken link anyways (plugin vs plugins). Point at the book instead.
The main page of the API docs referenced c_{str,vec}. Looks like these were deleted in 25d5a3a. Point at ffi docs instead.
|
@bors: r+ rollup |
|
📌 Commit 5123bf4 has been approved by |
|
Thanks! |
Found a few 404s that seemed like simple fixes: In footer.inc, certain 404 pages were 404ing on the request to jquery.js and playpen.js. This is easily demonstrated by visiting http://doc.rust-lang.org/foo then http://doc.rust-lang.org/foo/bar. The latter 404s, looking for foo/jquery.js. The Result docs use old_io Writer as an example. Fix the link to old_io Writer. There's probably an effort to update the example away from a deprecated api but this was a simple fix. rustc/plugin was pointing at the old guide and it was a broken link anyways (plugin vs plugins). Point at the book instead. The main page of the API docs referenced c_{str,vec}. Looks like these were deleted in 25d5a3a. Point at ffi docs instead.
Found a few 404s that seemed like simple fixes: In footer.inc, certain 404 pages were 404ing on the request to jquery.js and playpen.js. This is easily demonstrated by visiting http://doc.rust-lang.org/foo then http://doc.rust-lang.org/foo/bar. The latter 404s, looking for foo/jquery.js. The Result docs use old_io Writer as an example. Fix the link to old_io Writer. There's probably an effort to update the example away from a deprecated api but this was a simple fix. rustc/plugin was pointing at the old guide and it was a broken link anyways (plugin vs plugins). Point at the book instead. The main page of the API docs referenced c_{str,vec}. Looks like these were deleted in 25d5a3a. Point at ffi docs instead.
Found a few 404s that seemed like simple fixes:
In footer.inc, certain 404 pages were 404ing on the request to jquery.js and playpen.js. This is easily demonstrated by visiting http://doc.rust-lang.org/foo then http://doc.rust-lang.org/foo/bar. The latter 404s, looking for foo/jquery.js.
The Result docs use old_io Writer as an example. Fix the link to old_io Writer. There's probably an effort to update the example away from a deprecated api but this was a simple fix.
rustc/plugin was pointing at the old guide and it was a broken link anyways (plugin vs plugins). Point at the book instead.
The main page of the API docs referenced c_{str,vec}. Looks like these were deleted in 25d5a3a. Point at ffi docs instead.