Add contributor guide. #8715
Add contributor guide. #8715
Conversation
|
r? @Eh2406 (rust_highfive has picked a reviewer for you, use r? to override) |
|
The content looks great! Thank you so much! @alexcrichton would you take a second look at the CI changes? |
There was a problem hiding this comment.
Thanks so much for taking the time to do this @ehuss! This looks like a hugely beneficial resource. I skimmed the first half of teh book and it's all looking good to me so at that point I skipped to the end and figured that any further iteration can happen well enough in tree now.
| @@ -0,0 +1 @@ | |||
| # Architecture Overview | |||
There was a problem hiding this comment.
Not really stray, mdbook needs a page for nested chapters. I considered adding some high-level overview, but couldn't really think of what to add. I could also just add like a table-of-contents for the sub-chapter?
There was a problem hiding this comment.
Nah that's fine, I think mdbook will render this though and you can click on it on the left-hand-side navigation to see an empty page, so perhaps just a small blurb here to lay out what's contained within?
There was a problem hiding this comment.
Yea, sounds good! I added a short intro.
|
@bors: r+ 👍 |
|
📌 Commit b698b25 has been approved by |
|
☀️ Test successful - checks-actions |
Update cargo 8 commits in 05c611ae3c4255b7a2bcf4fcfa65b20286a07839..75615f8e69f748d7ef0df7bc0b064a9b1f5c78b2 2020-09-23 23:10:38 +0000 to 2020-09-29 18:42:19 +0000 - Correct mistake about supporting sub-makes and document CARGO_MAKEFLAGS (rust-lang/cargo#8741) - Properly set for_host for proc-macro tests. (rust-lang/cargo#8742) - Add Zsh completion for target triples (rust-lang/cargo#8740) - Reinitialize index on "Object not found" error. (rust-lang/cargo#8735) - Normalize raw string indentation. (rust-lang/cargo#8739) - Update links to rustup docs. (rust-lang/cargo#8738) - Add contributor guide. (rust-lang/cargo#8715) - Fix minor error in `cargo update` docs. (rust-lang/cargo#8737)
Update cargo 8 commits in 05c611ae3c4255b7a2bcf4fcfa65b20286a07839..75615f8e69f748d7ef0df7bc0b064a9b1f5c78b2 2020-09-23 23:10:38 +0000 to 2020-09-29 18:42:19 +0000 - Correct mistake about supporting sub-makes and document CARGO_MAKEFLAGS (rust-lang/cargo#8741) - Properly set for_host for proc-macro tests. (rust-lang/cargo#8742) - Add Zsh completion for target triples (rust-lang/cargo#8740) - Reinitialize index on "Object not found" error. (rust-lang/cargo#8735) - Normalize raw string indentation. (rust-lang/cargo#8739) - Update links to rustup docs. (rust-lang/cargo#8738) - Add contributor guide. (rust-lang/cargo#8715) - Fix minor error in `cargo update` docs. (rust-lang/cargo#8737)
This consolidates and extends the contributor information in a single place. This is an mdbook project, along with a CI job which will build and deploy it to GitHub Pages at https://rust-lang.github.io/cargo/contrib/.
You can view a rendered version here: https://ehuss.github.io/cargo/contrib/
I don't know if this will actually be helpful to anyone, but I figured it's worth a shot.
NOTE: The CI deploy is designed to preserve the existing gh-pages content. However, it will delete the history on that branch. I think that should be fine, there doesn't seem to be too much interesting stuff there. I do have a backup in my fork, though. Some extra scrutiny on the code might be wise. The reason it deletes the history is because deploying mdbook on every push would balloon the repository size.