broken links

[budziq]

There are currently at ~32 broken links in the cookbook. Tested with ruby html-proofer script.

This means that either:

• the descriptions have wrong links
• are outdated leading to outdated API's
• some crates docs have been broken (most likely rand in this case)

gem install html-proofer && htmlproofer --empty-alt-ignore ./book/ 

- ./book/basics.html
  *  External link https://doc.rust-lang.org/rand/rand/distributions/index.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/distributions/normal/struct.Normal.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/distributions/range/struct.Range.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/distributions/trait.IndependentSample.html#tymethod.ind_sample failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/fn.thread_rng.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rand.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rng.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rng.html#method.gen_range failed: 404 No error
  *  External link https://doc.rust-lang.org/regex/regex/struct.Regex.html failed: 404 No error
  *  External link https://doc.rust-lang.org/regex/regex/struct.Regex.html#method.captures_iter failed: 404 No error
  *  External link https://doc.rust-lang.org/regex/regex/struct.RegexSet.html failed: 404 No error
  *  External link https://doc.rust-lang.org/regex/regex/struct.RegexSetBuilder.html failed: 404 No error
  *  External link https://docs.rs/rand/ failed: 404 No error
  *  External link https://docs.rs/rand/*/rand/trait.Rng.html#method.choose failed: 404 No error
  *  External link https://docs.rs/rand/*/rand/trait.Rng.html#method.gen_ascii_chars failed: 404 No error
- ./book/encoding.html
  *  External link https://docs.rs/url/*/url/percent_encoding/fn.percent_decode.html failed: 404 No error
  *  External link https://docs.rs/url/*/url/percent_encoding/fn.utf8_percent_encode.html failed: 404 No error
- ./book/logging.html
  *  External link https://doc.rust-lang.org/log/env_logger/#enabling-logging failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/enum.Target.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/fn.init.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/struct.Builder.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/struct.Builder.html#method.target failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/struct.LogBuilder.html#method.format failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/struct.LogBuilder.html#method.init failed: 404 No error
  *  External link https://doc.rust-lang.org/log/env_logger/struct.LogBuilder.html#method.parse failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/enum.LogLevel.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/enum.LogLevelFilter.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/fn.set_logger.html failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/struct.LogRecord.html#method.args failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/struct.LogRecord.html#method.level failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/trait.Log.html failed: 404 No error
- ./book/print.html
  *  External link https://docs.rs/reqwest/*/reqwest/header/struct.ContentRange.htm failed: 404 No error
htmlproofer 3.8.0 | Error:  HTML-Proofer found 32 failures!

[AndyGauge]

Should we rethink using wildcard crate versions in links? Locking them down to the version we are using would fix some of the links.

[budziq]

locking to speciffic version will signifficantlybincrease maintenance burden at the cost of more broken links.

onbone hand it is an indicator that example is in a sense out of date but
on the other hand we already show rlthe latest badge advertizing support for rand 0.5.0.pre.1.
the real question is should we always track latest released version of given crate (I can't really say I'm loving such approach).

Hmm with some changes to how the links and badges are generated we could lock these to cargo.lock of skeptic tests

[dominikWin]

After #411 there are two groups of broken links:

- ./book/basics.html     
  *  External link https://doc.rust-lang.org/rand/rand/distributions/index.html failed: 404 No error 
  *  External link https://doc.rust-lang.org/rand/rand/distributions/normal/struct.Normal.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/distributions/range/struct.Range.html failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/distributions/trait.IndependentSample.html#tymethod.ind_sample failed: 404 No error
  *  External link https://doc.rust-lang.org/rand/rand/fn.thread_rng.html failed: 404 No error       
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rand.html failed: 404 No error          
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rng.html failed: 404 No error           
  *  External link https://doc.rust-lang.org/rand/rand/trait.Rng.html#method.gen_range failed: 404 No error
  *  External link https://docs.rs/rand/*/rand/trait.Rng.html#method.choose failed: 404 No error     
  *  External link https://docs.rs/rand/*/rand/trait.Rng.html#method.gen_ascii_chars failed: 404 No error
  *  External link https://docs.rs/ring/*/ring/digest/struct.Context.html failed: 404 No error       
  *  External link https://docs.rs/ring/*/ring/digest/struct.Digest.html failed: 404 No error        
  *  External link https://docs.rs/ring/*/ring/hmac/ failed: 404 No error                            
  *  External link https://docs.rs/ring/*/ring/hmac/struct.Signature.html failed: 404 No error       
  *  External link https://docs.rs/ring/*/ring/pbkdf2/fn.derive.html failed: 404 No error            
  *  External link https://docs.rs/ring/*/ring/pbkdf2/fn.verify.html failed: 404 No error            
  *  External link https://docs.rs/ring/*/ring/pbkdf2/index.html failed: 404 No error                
  *  External link https://docs.rs/ring/*/ring/rand/trait.SecureRandom.html#tymethod.fill failed: 404 No error
- ./book/concurrency.html                         
  *  External link https://docs.rs/rand/ failed: 404 No error                                        
  *  External link https://docs.rs/ring/ failed: 404 No error                                        
- ./book/logging.html    
  *  External link https://doc.rust-lang.org/log/log/enum.LogLevel.html failed: 404 No error         
  *  External link https://doc.rust-lang.org/log/log/enum.LogLevelFilter.html failed: 404 No error   
  *  External link https://doc.rust-lang.org/log/log/fn.set_logger.html failed: 404 No error         
  *  External link https://doc.rust-lang.org/log/log/struct.LogRecord.html#method.args failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/struct.LogRecord.html#method.level failed: 404 No error
  *  External link https://doc.rust-lang.org/log/log/trait.Log.html failed: 404 No error             
  *  External link https://docs.rs/env_logger/*/env_logger/enum.Target.html failed: 404 No error     
  *  External link https://docs.rs/env_logger/*/env_logger/struct.LogBuilder.html#method.format failed: 404 No error
  *  External link https://docs.rs/env_logger/*/env_logger/struct.LogBuilder.html#method.init failed: 404 No error
  *  External link https://docs.rs/env_logger/*/env_logger/struct.LogBuilder.html#method.parse failed: 404 No error
htmlproofer 3.8.0 | Error:  HTML-Proofer found 30 failures!

• Broken crate docs (rand and ring)
• Outdated API (log and env_logger), see Update the logging section to log 0.4, log4rs 0.8 env_logger 0.5 #383

ring has its documentation hosted at https://briansmith.org/rustdoc/ring/ (from Cargo.toml/crates.io). Updating to this removes 8 bad links. Should we link to a non-docs.rs location?

[budziq]

Thanks for looking into it @dominikWin!

ring has its documentation hosted at https://briansmith.org/rustdoc/ring/ (from Cargo.toml/crates.io). Updating to this removes 8 bad links. Should we link to a non-docs.rs location?

While I'd preffer to have only docs.rs links for easier maintenability it is reasonable to follow crate authors wishes about where is their cannonical docs location (as pointed by cargo.toml). So I'd suggest to link to docs pointed by cargo.toml by default and use docs.rs as fallback.

[budziq]

after #412 and #413 we are down to 8 broken links from rand

[dominikWin]

The docs for rand came back online. #417 fixes the links to them.
After this there is only one broken link:

- ./book/basics.html
  *  External link https://doc.rust-lang.org/rand/*/rand/distributions/range/struct.Range.html failed: 404 No error
htmlproofer 3.8.0 | Error:  HTML-Proofer found 1 failure!

This is caused by removing Range and replacing it with Uniform distribution in 0.5. When rand 0.5 stable comes out the recipe will need to be updated along with the link.