Tracking issue for RFC 1828: Rust Bookshelf #39588

steveklabnik · 2017-02-06T18:14:34Z

steveklabnik · 2017-02-06T18:22:30Z

@brson @alexcrichton can we coordinate soon on getting this implemented? We had talked very broadly about it before, now it's time to get concrete 😄

Some of this is blocked by #39431, I believe, which is the blocker for using mdbook to build. The rest of it is blocked on being able to integrate the out-of-tree stuff into the builds.

Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588

tshepang · 2017-02-06T21:10:43Z

@steveklabnik Will 2nd edition be moved elsewhere when 1st edition moves to rust-lang/book?

steveklabnik · 2017-02-06T21:11:51Z

@tshepang the idea is that they will both be in the same repository. The exact strategy isn't totally clear; we'll see as we dig into packaging implementation details.

I am imagining sub-folders.

…, r=frewsxcv Re-write the doc index page Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588

@alexcrichton

Port books to mdbook Part of #39588 blocked on #39431 As a first step towards the bookshelf, we ~vendor mdbook in-tree and~ port our books to it. Eventually, both of these books will be moved out-of-tree, but the nightly book will rely on doing the same thing. As such, this intermediate step is useful. r? @alexcrichton @brson /cc @azerupi

Part of rust-lang#39588.

This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

@frewsxcv

Port the reference to mdbook Part of #39588. This is only a work in progress. Still left to do: - [x] double check contents weren't duplicated/lost with the move to individual pages (I'm going to do this) - [x] fix up links [and footnotes](#39855 (comment)) (@frewsxcv has volunteered to help with this) - [x] change `src/doc/reference.md` to redirect to the book - [x] move the reference on the doc index to be part of the bookshelf

part of rust-lang#39588

@alexcrichton

…xcrichton Extract nomicon to its own repo part of rust-lang#39588 same as rust-lang#40213 but for the nomicon r? @alexcrichton

steveklabnik · 2017-03-15T21:28:24Z

Docs team triage: p-medium. #40332 and cargo work outstanding.

@alexcrichton

…ichton Extract book into a submodule Part of rust-lang#39588 We probably don't want to land this till after the beta branches on friday, but would still ❤️ a review from @alexcrichton , since I am a rustbuild noob. This pr: 1. removes the book 2. adds it back in as a submodule 3. the submodule includes both the old book and the new book 4. it also includes an index page explaining the difference in editions 5. it also includes redirect pages for the old book URLs. 6. so we build all that stuff too. r? @alexcrichton

@alexcrichton

…ichton Extract book into a submodule Part of rust-lang#39588 We probably don't want to land this till after the beta branches on friday, but would still ❤️ a review from @alexcrichton , since I am a rustbuild noob. This pr: 1. removes the book 2. adds it back in as a submodule 3. the submodule includes both the old book and the new book 4. it also includes an index page explaining the difference in editions 5. it also includes redirect pages for the old book URLs. 6. so we build all that stuff too. r? @alexcrichton

@alexcrichton

Port books to mdbook Part of rust-lang/rust#39588 blocked on rust-lang/rust#39431 As a first step towards the bookshelf, we ~vendor mdbook in-tree and~ port our books to it. Eventually, both of these books will be moved out-of-tree, but the nightly book will rely on doing the same thing. As such, this intermediate step is useful. r? @alexcrichton @brson /cc @azerupi

@alexcrichton

Extract book into a submodule Part of rust-lang/rust#39588 We probably don't want to land this till after the beta branches on friday, but would still ❤️ a review from @alexcrichton , since I am a rustbuild noob. This pr: 1. removes the book 2. adds it back in as a submodule 3. the submodule includes both the old book and the new book 4. it also includes an index page explaining the difference in editions 5. it also includes redirect pages for the old book URLs. 6. so we build all that stuff too. r? @alexcrichton

behnam · 2017-08-12T00:02:46Z

A kind of unrelated question here: is there a way to see the https://doc.rust-lang.org/ website for beta and nightly channel? Maybe on a different domain?

I'm asking to understand how I can actually see the changes when working on migrating Cargo docs to the Bookshelf. (rust-lang/cargo#4040)

QuietMisdreavus · 2017-08-12T04:53:51Z

@behnam All the releases and release channels have subfolders on doc.rust-lang.org. So nightly is on https://doc.rust-lang.org/nightly/ and beta is on https://doc.rust-lang.org/beta/. Whenever you link the cargo docs in with the rest of the rust docs, the full doc bundle is made when you run an ./x.py doc on the rust repo, and placed in build/$TARGET/doc.

behnam · 2017-08-12T07:49:51Z

Thanks, @QuietMisdreavus, for the info. So now I know how to test the full docs build locally.

behnam · 2017-09-28T22:33:30Z

Update on Cargo docs

We are done with preparing the Cargo docs in book format, which was rust-lang/cargo#4040

I have filed #44910 for the next steps. We can add this to the list in the description here.

Fixes rust-lang#44910 Fixes rust-lang#39588 See both of those bugs for more details.

Start shipping the Cargo book Fixes #44910 Fixes #39588 See both of those bugs for more details.

This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

steveklabnik added A-docs B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Feb 6, 2017

steveklabnik self-assigned this Feb 6, 2017

steveklabnik mentioned this issue Feb 6, 2017

Rust bookshelf rust-lang/rfcs#1828

Merged

steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 6, 2017

Re-write the doc index page

acd84c2

Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588

steveklabnik mentioned this issue Feb 6, 2017

Re-write the doc index page #39593

Merged

steveklabnik mentioned this issue Feb 8, 2017

Port books to mdbook #39633

Merged

steveklabnik mentioned this issue Feb 15, 2017

Port the reference to mdbook #39855

Merged

4 tasks

steveklabnik mentioned this issue Feb 15, 2017

Create the Unstable Book #39866

Merged

2 tasks

steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 20, 2017

Port the reference to mdbook

454ea85

Part of rust-lang#39588.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 21, 2017

Start the port of the reference to mdBook

c937254

This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 22, 2017

Create "The Unstable Book"

a1301c3

part of rust-lang#39588

arielb1 pushed a commit to arielb1/rust that referenced this issue Mar 8, 2017

Rollup merge of rust-lang#40222 - steveklabnik:extract-nomicon, r=ale…

7c18194

…xcrichton Extract nomicon to its own repo part of rust-lang#39588 same as rust-lang#40213 but for the nomicon r? @alexcrichton

steveklabnik added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Mar 10, 2017

carols10cents mentioned this issue Mar 14, 2017

SSL certificate issue https:://doc.crates.io rust-lang/crates.io#621

Closed

steveklabnik added the P-medium Medium priority label Mar 15, 2017

steveklabnik removed the A-docs label Mar 24, 2017

carols10cents mentioned this issue May 13, 2017

Pull the cargo docs out of tree and convert them to mdBook rust-lang/cargo#4040

Closed

istankovic mentioned this issue Jun 25, 2017

Doc migration rust-lang/cargo#4220

Closed

Mark-Simulacrum added the C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. label Jul 27, 2017

behnam mentioned this issue Sep 28, 2017

Publish Cargo Manual on the bookshelf #44910

Closed

steveklabnik mentioned this issue Nov 1, 2017

Start shipping the Cargo book #45692

Merged

steveklabnik added a commit to steveklabnik/rust that referenced this issue Nov 14, 2017

Start shipping the Cargo book

623886f

Fixes rust-lang#44910 Fixes rust-lang#39588 See both of those bugs for more details.

bors added a commit that referenced this issue Nov 16, 2017

Auto merge of #45692 - steveklabnik:ship-cargo-book, r=alexcrichton

42ea30c

Start shipping the Cargo book Fixes #44910 Fixes #39588 See both of those bugs for more details.

bors closed this as completed in #45692 Nov 16, 2017

dlrobertson pushed a commit to dlrobertson/rust that referenced this issue Nov 29, 2018

Start the port of the reference to mdBook

4a2bdf8

This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracking issue for RFC 1828: Rust Bookshelf #39588

Tracking issue for RFC 1828: Rust Bookshelf #39588

steveklabnik commented Feb 6, 2017 •

edited by carols10cents

Loading

steveklabnik commented Feb 6, 2017 •

edited

Loading

tshepang commented Feb 6, 2017

steveklabnik commented Feb 6, 2017 •

edited

Loading

steveklabnik commented Mar 15, 2017

behnam commented Aug 12, 2017

QuietMisdreavus commented Aug 12, 2017

behnam commented Aug 12, 2017

behnam commented Sep 28, 2017

Tracking issue for RFC 1828: Rust Bookshelf #39588

Tracking issue for RFC 1828: Rust Bookshelf #39588

Comments

steveklabnik commented Feb 6, 2017 • edited by carols10cents Loading

infra

porting

extracting

steveklabnik commented Feb 6, 2017 • edited Loading

tshepang commented Feb 6, 2017

steveklabnik commented Feb 6, 2017 • edited Loading

steveklabnik commented Mar 15, 2017

behnam commented Aug 12, 2017

QuietMisdreavus commented Aug 12, 2017

behnam commented Aug 12, 2017

behnam commented Sep 28, 2017

Update on Cargo docs

steveklabnik commented Feb 6, 2017 •

edited by carols10cents

Loading

steveklabnik commented Feb 6, 2017 •

edited

Loading

steveklabnik commented Feb 6, 2017 •

edited

Loading