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

Re-write the documentation index #49628

Merged
merged 1 commit into from
Apr 5, 2018

Conversation

steveklabnik
Copy link
Member

The docs team has decided that we're framing resources in three ways:
"learning Rust," "using Rust," "mastering Rust." This is a more useful
split than "beginner/intermediate/advanced." As we add more resources
in the future, we expect "using Rust" to grow. "the bookshelf" as a
concept is great, but isn't really organized along these lines. As such,
this reorganizes the docs along these lines.

r? @rust-lang/docs

@TimNN
Copy link
Contributor

TimNN commented Apr 3, 2018

Your PR failed on Travis. Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.
[00:00:55] configure: rust.quiet-tests     := True
---
[00:40:08] ..........................................................................i.........................
[00:40:14] .................i..................................................................................
---
[00:40:49] .............................................................................................i......
[00:40:56] .................................................................i..................................
---
[00:41:51] .............................................i......................................................
---
[00:45:43] .............................i......................................................................
[00:45:57] ..............................................................i.....................................
[00:46:13] ...............................................i....................................................
[00:46:33] ....................................................................................................
[00:46:54] ....................................................................................................
[00:47:16] ....................................................................................................
[00:47:41] .i...............................................................................................i..
[00:48:08] .................................................................................test [run-pass] run-pass/mir_heavy_promoted.rs has been running for over 60 seconds
[00:48:18] ...................
[00:48:48] ....................................................................................................
[00:49:23] ..............................................................ii....................................
[00:50:09] .........................i....................................................i.ii.....test [run-pass] run-pass/saturating-float-casts.rs has been running for over 60 seconds
[00:50:13] .............
[00:50:53] ......................................................................................iiiiiii.......
---
[00:52:53] ....................................i...............................................................
[00:53:01] ....................................................................................................
[00:53:08] ..................i............................................................ii.iii...............
[00:53:15] ....................................................................................................
[00:53:23] ........i..............................i............................................................
[00:53:30] ....................................................................................................
[00:53:37] .....................i..............................................................................
[00:53:45] ....................................................................................................
[00:53:55] ....................................................................................................
[00:54:05] ....................................................................................................
[00:54:16] ....................................................................................................
[00:54:30] ....................................................................................................
[00:54:38] ..............i.....................................................................................
[00:54:48] .................i..ii..............................................................................
[00:54:58] ....................................................................................................
[00:55:08] ....................................................................................................
[00:55:18] .....................................................................................i..............
[00:55:28] ...............................i....................................................................
---
[00:56:05] ...........................i........................................................................
[00:56:07] ....................................................................i...............................
[00:56:08] ................i.......................................................
---
[00:56:22] ...........i........................
---
[00:56:52] i....i.ii....i.............ii........iii......i..i...i...ii..i..i..ii.....
---
[00:56:55] i.......i......................i......
---
[00:57:31] iiii.......i..i........i..i.i.............i..........iiii...........i...i..........ii.i.i.......ii..
[00:57:32] ....ii...
---
[01:06:38] ...i................................................................................................
---
[01:08:27] ......................................i.............................................................
[01:08:46] ....................................................................................................
[01:09:06] .............................................i......................................................
---
[01:10:33] ..........................................................ii........................................
---
[01:11:35] ..............................................................i.....................................
---
[01:16:13] ii..................................................................................................
[01:16:31] ....................................................................................................
[01:16:47] ...................iii......i......i...i......i.....................................................
[01:16:56] ....................................................................................................
[01:17:11] ........................................iiii........ii..............................................
[01:17:22] ....................................................................................................
[01:17:38] .......................................................................................i............
---
[01:24:02] index.html:80: broken link - err-index.html
[01:24:18] thread 'main' panicked at 'found some broken links', tools/linkchecker/main.rs:49:9
---
[01:24:18] Makefile:58: recipe for target 'check' failed
[01:24:18] make: *** [check] Error 1
---
$ cat obj/tmp/sccache.log

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN.

src/doc/index.md Outdated
[rustdoc-book]: rustdoc/index.html
[cargo-book]: cargo/index.html
diagnostics from the compiler on those errors. You can also [read them
here](err-index.html), if you prefer to read them that way.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link should point to error-index.html

@QuietMisdreavus
Copy link
Member

Overall, this gets a 👍 from me, though it's kind of an overhaul and likely to generate lots of Opinions. I'd like to see what the rest of @rust-lang/docs thinks.

The docs team has decided that we're framing resources in three ways:
"learning Rust," "using Rust," "mastering Rust." This is a more useful
split than "beginner/intermediate/advanced." As we add more resources
in the future, we expect "using Rust" to grow. "the bookshelf" as a
concept is great, but isn't really organized along these lines. As such,
this reorganizes the docs along these lines.
@steveklabnik steveklabnik added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 3, 2018
@steveklabnik
Copy link
Member Author

Let's do it this way:

@rfcbot fcp merge

@rfcbot rfcbot added the proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. label Apr 3, 2018
@rfcbot
Copy link

rfcbot commented Apr 3, 2018

Team member @steveklabnik has proposed to merge this. The next step is review by the rest of the tagged teams:

No concerns currently listed.

Once a majority of reviewers approve (and none object), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@steveklabnik
Copy link
Member Author

Checked of @QuietMisdreavus as per 👍 above

Copy link
Member

@frewsxcv frewsxcv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, love these new categories ✨

@rfcbot rfcbot added the final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. label Apr 3, 2018
@rfcbot
Copy link

rfcbot commented Apr 3, 2018

🔔 This is now entering its final comment period, as per the review above. 🔔

@rfcbot rfcbot removed the proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. label Apr 3, 2018
@GuillaumeGomez
Copy link
Member

👍

@steveklabnik
Copy link
Member Author

@bors: r=QuietMisdreavus

thanks everyone!

@bors
Copy link
Contributor

bors commented Apr 4, 2018

📌 Commit 77b570f has been approved by QuietMisdreavus

@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Apr 4, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Apr 4, 2018
…ietMisdreavus

Re-write the documentation index

The docs team has decided that we're framing resources in three ways:
"learning Rust," "using Rust," "mastering Rust." This is a more useful
split than "beginner/intermediate/advanced." As we add more resources
in the future, we expect "using Rust" to grow. "the bookshelf" as a
concept is great, but isn't really organized along these lines. As such,
this reorganizes the docs along these lines.
bors added a commit that referenced this pull request Apr 4, 2018
Rollup of 25 pull requests

Successful merges:

 - #49179 (Handle future deprecation annotations )
 - #49512 (Add support for variant and types fields for intra links)
 - #49515 (fix targetted value background)
 - #49516 (Add missing anchor for union type fields)
 - #49532 (Add test for rustdoc ignore test)
 - #49533 (Add #[must_use] to a few standard library methods)
 - #49540 (Fix miri Discriminant() for non-ADT)
 - #49559 (Introduce Vec::resize_with method (see #41758))
 - #49570 (avoid IdxSets containing garbage above the universe length)
 - #49577 (Stabilize String::replace_range)
 - #49599 (Fix typo)
 - #49603 (Fix url for intra link provided method)
 - #49607 (Stabilize iterator methods in 1.27)
 - #49609 (run-pass/attr-stmt-expr: expand test cases)
 - #49612 (Fix "since" version for getpid feature.)
 - #49618 (Fix build error when compiling libcore for 16bit targets)
 - #49619 (tweak core::fmt docs)
 - #49637 (Stabilize parent_id())
 - #49639 (Update Cargo)
 - #49628 (Re-write the documentation index)
 - #49594 (Add some performance guidance to std::fs and std::io docs)
 - #49625 (miri: add public alloc_kind accessor)
 - #49634 (Add a test for the fix to issue #43058)
 - #49641 (Regression test for #46314)
 - #49547 (Unignore borrowck test)

Failed merges:
@alexcrichton alexcrichton merged commit 77b570f into rust-lang:master Apr 5, 2018
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 final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants