Add the rust-wasm-book #12
Conversation
|
cc/ |
|
I'd be delighted to get this organized as a growing book of resources! This looks like a good start in that direction. I wonder whether the whole repository should just be the book, rather than separating that as a subdirectory. In particular, I was only ever imagining having So for example, the README could probably also be split up into book sections etc. We'll also want to get it hosted somewhere, etc. |
|
@aturon that seems fairly reasonable. |
rust-wasm-book/src/setup.md
Outdated
| If you want to be able to use Rust for wasm then you need an environment to be able to do that! If | ||
| you haven't already you'll need to install [rustup][rustup] the official tool in order to install | ||
| and manage different versions of the Rust compiler. Follow the instructions on the site to get it | ||
| installed on your machine. Once that's installed you'll need to get the `wasm32-uknown-unkown` |
There was a problem hiding this comment.
Second should be unknown not unkown
|
@mgattozzi Let's put it up on github pages for now. This will probably eventually head to the nursery, but I don't think we're there yet. Want to make the updates to the PR? |
|
@aturon sounds good! I'll get a TravisCI build running as well so it can push it automagically. |
|
ping on this? |
|
@aturon was busy this week with some other things (related to Rust that I can't talk about)/in the process of building a new desktop so I can work at home on this kind of stuff. I'll take a look at it tonight. Shouldn't be too hard to get this working. To clarify we wanted this on the top level right rather than a subdirectory? |
Yep! Let's basically turn the whole repo into a loose "book" that we'll organize organically over time. |
|
@aturon I've rebased and pushed a newer version. We'll still need to set up travis with the GH Token as well but I think this should do it! |
|
Ping @aturon I don't think I have the permissions level to set this up fully (like getting a GH Token for the repo). I'll probably need your help for the last bit. |
|
@mgattozzi I went a step further and transferred this to the nursery, and made you (and others) full admins. We should get it hooked into the hosting for the nursery. Not sure what's needed for that. @alexcrichton? |
|
@mgattozzi Looks like you should be able to follow the pattern in the API Guidelines and Cookbook: |
|
Hey @aturon good to know. I'll copy it over and then we can do a final check then push it! |
|
I've enabled Travis for this repo and kicked it as well, I think that should do it when you're ready! |
|
@aturon and @alexcrichton I updated the scripts but I had no idea what email to use so I just put wasm@rust-lang.org in the deploy script. Let me know if anything needs to get changed. I'll keep a check on the CI and fix any issues that come up in the meantime |
|
@mgattozzi Thanks! I added that email alias to send to you, me and @alexcrichton for now. Looks like the build is failing though. |
|
Hey @aturon looks like I removed |
|
Still failing. |
|
TDD: Travis Driven Development But on a serious note I think this should work now. The problem was there was a cache for cargo. This included installs. I removed it but added the force flag as a "just in case" failsafe for mdbook. |
|
lol now it's trying to build a rust project hold on. Again. -_- |
|
Ah I need to make the token for this repo I think. |
|
Okay this is getting annoying. Apparently whatever I'm doing is not setting the token correctly. Going to try a few more things. |
|
Okay that build is going to fail. Need to figure out why. The token I'm using works when tested locally. |
|
Ugh that's not right either even though it'll be green. |
|
I encrypted the variable as GH_PAGES not GH_TOKEN. This should do it. |
|
Alright I'm at a loss as to why the token isn't set properly Using the travis ruby gem I ran: travis encrypt -a env.global -r rust-lang-nursery/rust-wasm GH_TOKEN="actual token here"Which added it to the file but travis can't find it for whatever reason when building. |
.travis.yml
Outdated
| - stable | ||
| os: | ||
| - linux | ||
| - osx |
There was a problem hiding this comment.
You can probably delete this as I don't think this'll need to be run on both OSX and Linux, right?
There was a problem hiding this comment.
Yeah. this was copied over from the rust cook book. They're doing some compilation of actual rust code and probably needed this
|
Eyyyy a new error message. Okay looks like I need to put in the token correctly. |
|
I've directly set the token in the dashboard and used Travis' deploy to gh-pages service. Let's see if this is the one that works. |
This book seeks to aggregate various documents into one place making it easy to display the documentation online much like we do with TRPL and to make a central area for writing those documents. This splits up the `workflows.md` file into a basic hello-world chapter, a modified setup chapter, and then an actual workflows chapter that can be worked on with things that are more like workflows than examples per se. The README has been update on how to build the book and what the book is about for those wishing to contribute to those docs.
|
@aturon and @alexcrichton I added the token used in the |
|
Ok! |
|
Are there additional steps we need for the actual publication? I'm not seeing it at https://rust-lang-nursery.github.io/rust-wasm/ |
|
I didn't dig into it, but there's no |
|
Hmmm. Alright I can create and manually deploy it for now. |
|
Er wait hang on, I think I may have found something |
|
Nice |
This book seeks to aggregate various documents into one place making it
easy to display the documentation online much like we do with TRPL and
to make a central area for writing those documents.
This splits up the
workflows.mdfile into a basic hello-world chapter,a modified setup chapter, and then an actual workflows chapter that can
be worked on with things that are more like workflows than examples per
se.
Also included is a README on how to build the book and what the book is
about for those wishing to contribute to those docs.