Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish Cargo Manual on the bookshelf #44910

Closed
behnam opened this issue Sep 28, 2017 · 5 comments
Closed

Publish Cargo Manual on the bookshelf #44910

behnam opened this issue Sep 28, 2017 · 5 comments
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-high High priority

Comments

@behnam
Copy link
Contributor

behnam commented Sep 28, 2017

Background

In rust-lang/cargo#4040, we re-organized Cargo documentations into one single in-repo mdBook, called "Cargo Manual". The preview is available on http://doc.crates.io/book/

Now

The last step is to publish the book on https://doc.rust-lang.org/cargo/, which requires work in this repo (rust).

Follow-up

After this, we should create a new tracker issue in Cargo to deprecate doc.crates.io and redirect them to doc.rust-lang.org. [rust-lang/cargo#4694]

Part of #39588

@TimNN TimNN added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Oct 1, 2017
@steveklabnik steveklabnik added the P-high High priority label Oct 31, 2017
@steveklabnik steveklabnik self-assigned this Oct 31, 2017
@steveklabnik
Copy link
Member

I took a stab at this today, but didn't get it working; our book build system generally expects for the book to be in the src\doc directory, trying to build from a different one seems to confuse it. More investigation tomorrow!

@behnam
Copy link
Contributor Author

behnam commented Nov 1, 2017

Yeah, I ended up in a similar situation and started touching many functions to make them flexible enough to handle this case.

If you think it's better to make changes on the cargo repo side to make it easier to adapt here, I can help with it. One solution would be to move the old docs into cargo/src/doc-old/ and move cargo/src/doc/book/ into cargo/src/doc/.

@steveklabnik
Copy link
Member

steveklabnik commented Nov 1, 2017

Let me give it another go before we try that; I'm not totally sure that helps a ton. That is, as far as I can tell, it'd have to literally be in src/doc for it to be easy.

@steveklabnik
Copy link
Member

I did it! PR incoming.

@behnam
Copy link
Contributor Author

behnam commented Nov 2, 2017

Awesome, @steveklabnik!

I created a follow up task on Cargo to finish the migration: rust-lang/cargo#4694

steveklabnik added a commit to steveklabnik/rust that referenced this issue Nov 14, 2017
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
 Start shipping the Cargo book

Fixes #44910
Fixes #39588

See both of those bugs for more details.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-high High priority
Projects
None yet
Development

No branches or pull requests

3 participants