Cookbook 1.0

[AndyGauge]

What will it take for us to call the cookbook 1.0?

First thing: A huge shout out to @budziq and the improvements he has made to the cookbook. I am continually impressed by your effort.

I want to draw a line in the sand that we can release the cookbook. What I think should be in scope of this release:

• mdbook v.0.1.7
• Reorganize #404 (ready)
• Spell Checker #410 (ready)
• proofread run #404 (ready)
• broken links #404 (ready)
• spell checker only #410 (ready)
• table sync issue #404 (ready)
• link checker #410 (ready)
• Update Contributing and PR Template for linters #404 (ready)
• use mdbook master branch?

What I want to keep active (for post 1.0) is:

• Overhaul

There are a few PRs that are sitting in the queue. It is going to take some effort to get them to merge after #404 lands. I'd be happy to finish the outstanding work on them and include them in a 1.0 release.

Here's the original discussion at ecosystem-wg.

I'd love some feedback on what you'd like to see done before stamping the Rust Cookbook 1.0

[budziq]

I fully agree with the idea!

Ive created a milestone to aggregate the issues that most likely should be addressed before 1.0 release.

I'd propose to also address:

• proofread run
• broken links
• spell checker only

optionally:

• table sync issue
• link checker

Not sure if we will be ready for 1.0 then but it should be a good approximation to present to the libs team :)

[AndyGauge]

I've added all those to the original comment. Let's do this thing!

[AndyGauge]

I think we are only missing the updates to the CONTRIBUTING and PR Template to support this purposed 1.0 rewrite.

[AndyGauge]

Actually, we need to determine if the Cookbook will rely on a git version of mdbook or wait until 1.8 drops. Either way, build scripts and README needs to be updated.

[AndyGauge]

In order to build mdbook from master on rust 1.27, rust-lang/cargo#5627 dictates specifying the version (--version 0.1.8-alpha.0) which is brittle. I want to wait until 0.1.8 lands unless rust 1.28 stabilizes first.

[AndyGauge]

0.1.8 landed this morning, I built the branch successfully!

[AndyGauge]

I merged the Reorganize branch #404
Watching for issues in the CI.

[budziq]

Thanks for pushing this through the finish line @AndyGauge ! 🎉 ❤️

[AndyGauge]

Our imaginary line in the sand is complete.