Stream: wg-async-foundations/book

Topic: weekly meeting 2019.06.11


Taylor Cramer (Jun 11 2019 at 16:38, on Zulip):

reposting what I'd said in the other stream:

Taylor Cramer (Jun 11 2019 at 16:38, on Zulip):

howdy, all!
update on book things:

I've gotten link checker running on the book and am working to pull out the example code into separate projects in an examples/ workspace inside the async book repo, update those to the current library/syntax, and get tests running in CI. Once that's done, it should be easier to start accepting PRs for new content.

If anyone wants to start working on content, feel free to take a look at the table of contents: https://github.com/rust-lang/async-book/blob/master/src/SUMMARY.md, and open an issue mentioning that you plan to get started

There's a lot there left TODO, and I'll aim to have a PR up today with the examples and everything factored out so we can get started

Taylor Cramer (Jun 11 2019 at 16:39, on Zulip):

I don't have any other updates to give, but if someone has a topic they'd like to discuss we could take some time to do that as a group

Yoshua Wuyts (Jun 11 2019 at 16:40, on Zulip):

I don't have much right now; I mentioned in last week's Async Eco WG meeting that we'd be having this meeting today.

nikomatsakis (Jun 11 2019 at 16:40, on Zulip):

Is it now checking that the code examples build?

Yoshua Wuyts (Jun 11 2019 at 16:40, on Zulip):

(hoping we can funnel folks from the eco WG in here to help out :smile:)

Taylor Cramer (Jun 11 2019 at 16:40, on Zulip):

@nikomatsakis it is not, but that was what I was referring to when I talked about moving the examples into cargo projects within an examples/ workspace

nikomatsakis (Jun 11 2019 at 16:41, on Zulip):

@Taylor Cramer ok -- I think if you use mdbook, you can do mdbook test to test the code examples, also?

Taylor Cramer (Jun 11 2019 at 16:41, on Zulip):

if there's another way to do that you know which works well with dependencies on crates.io libraries, I'd be happy to hear

nikomatsakis (Jun 11 2019 at 16:41, on Zulip):

though I'm not sure

nikomatsakis (Jun 11 2019 at 16:41, on Zulip):

yeah, maybe it doesn't handle the deps very well

Taylor Cramer (Jun 11 2019 at 16:41, on Zulip):

^^yes, but i think it requires manual -L lines for deps

nikomatsakis (Jun 11 2019 at 16:41, on Zulip):

:/

Taylor Cramer (Jun 11 2019 at 16:41, on Zulip):

which isn't that bad, but I think would turn a bit more "bespoke"

nikomatsakis (Jun 11 2019 at 16:41, on Zulip):

let's first spend 6 months building a good tool

Taylor Cramer (Jun 11 2019 at 16:41, on Zulip):

;)

nikomatsakis (Jun 11 2019 at 16:42, on Zulip):

also there are some things that could be better in markdown

nikomatsakis (Jun 11 2019 at 16:42, on Zulip):

so let's fix that too

Taylor Cramer (Jun 11 2019 at 16:42, on Zulip):

haha

nikomatsakis (Jun 11 2019 at 16:42, on Zulip):

/me stops

Yoshua Wuyts (Jun 11 2019 at 16:42, on Zulip):

lol

Taylor Cramer (Jun 11 2019 at 16:42, on Zulip):

so yeah I was gonna not solve that problem

nikomatsakis (Jun 11 2019 at 16:42, on Zulip):

I think a good bit of homework for me would be to sit down and read the whole book "cover to cover" :)

nikomatsakis (Jun 11 2019 at 16:43, on Zulip):

regardless, it'd be nice to have it rendered at rust-lang.github.io/async-book etc

Taylor Cramer (Jun 11 2019 at 16:43, on Zulip):

that'd probably yield better results once any of the code examples compiled or were up-to-date ;)

nikomatsakis (Jun 11 2019 at 16:43, on Zulip):

not sure if that's also what you meant in your paragraph above

nikomatsakis (Jun 11 2019 at 16:43, on Zulip):

tbh I found it kind of hard to parse :P

Taylor Cramer (Jun 11 2019 at 16:43, on Zulip):

Oh, sorry

Taylor Cramer (Jun 11 2019 at 16:43, on Zulip):

Yes, currently the .travis.yml file uploads it

nikomatsakis (Jun 11 2019 at 16:44, on Zulip):

oh hey it works already sorry i'll just shut up

Taylor Cramer (Jun 11 2019 at 16:45, on Zulip):

The bit I was talking about was two things:
- adding link checker so we can be sure that internal links between the pages don't go stale (DONE)
- moving code examples into a cargo workspace and using the mdbook #include syntax to pull the relevant parts into the docs

Taylor Cramer (Jun 11 2019 at 16:45, on Zulip):

https://rust-lang-nursery.github.io/mdBook/format/mdbook.html is the relevant section of the docs

Taylor Cramer (Jun 11 2019 at 16:46, on Zulip):

https://rust-lang-nursery.github.io/mdBook/format/mdbook.html#including-files, rather

Taylor Cramer (Jun 11 2019 at 16:46, on Zulip):

then we can use cargo test --all inside examples/ to ensure that all the code is still building and running correctly

nikomatsakis (Jun 11 2019 at 16:48, on Zulip):

@Taylor Cramer would you object if I fork the repo and experiment with a bit of TOC reordering?

nikomatsakis (Jun 11 2019 at 16:48, on Zulip):

I had an idea I wanted to try out

nikomatsakis (Jun 11 2019 at 16:48, on Zulip):

may or may not be an improvement...

Taylor Cramer (Jun 11 2019 at 16:48, on Zulip):

@nikomatsakis nope, that's fine by me, but i'd been planning to do some rearranging myself

nikomatsakis (Jun 11 2019 at 16:48, on Zulip):

specifically I was thinking like this:

Taylor Cramer (Jun 11 2019 at 16:48, on Zulip):

happy to have you take a look at it though, as a new set of eyes is always good

nikomatsakis (Jun 11 2019 at 16:50, on Zulip):

ok cool

nikomatsakis (Jun 11 2019 at 16:51, on Zulip):

I'm also going to read it and see how much I understand :)

Last update: Nov 15 2019 at 11:05UTC