Add the Guide, add warning to tutorial.

In line with what @brson, @cmr, @nikomatsakis and I discussed this morning, my
redux of the tutorial will be implemented as the Guide. This way, I can work in
small iterations, rather than dropping a huge PR, which is hard to review.  In
addition, the community can observe my work as I'm doing it.

This adds a note in line with [this comment][reddit] that clarifies the state
of the tutorial, and the community's involvement with it.

[reddit]: http://www.reddit.com/r/rust/comments/28bew8/rusts_documentation_is_about_to_drastically/ci9c98k

diff --git a/configure b/configure
index fa87e5aa1961cf2d0ae9bf246bc6c3a700939dac..59aa6ece6b2f1c230fa028f2ff722afc1b7758f5 100755 (executable)
--- a/configure
+++ b/configure
@@ -869,6 +869,7 @@ do
     make_dir $h/test/debuginfo-lldb
     make_dir $h/test/codegen
     make_dir $h/test/doc-tutorial
+    make_dir $h/test/doc-guide
     make_dir $h/test/doc-guide-ffi
     make_dir $h/test/doc-guide-runtime
     make_dir $h/test/doc-guide-macros

diff --git a/mk/docs.mk b/mk/docs.mk
index 68d4e19afa602ccb0baf8ba05fd5ddfbe6bf5b7b..8098a0682a5d0f719d31f4d5b07cab8182382db9 100644 (file)
--- a/mk/docs.mk
+++ b/mk/docs.mk
@@ -26,7 +26,7 @@
 # L10N_LANGS are the languages for which the docs have been
 # translated.
 ######################################################################
-DOCS := index intro tutorial guide-ffi guide-macros guide-lifetimes \
+DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
        guide-tasks guide-container guide-pointers guide-testing \
        guide-runtime complement-bugreport \
        complement-lang-faq complement-design-faq complement-project-faq rust \

diff --git a/src/doc/guide.md b/src/doc/guide.md
new file mode 100644 (file)
index 0000000..59fb050
--- /dev/null
+++ b/src/doc/guide.md
@@ -0,0 +1,10 @@
+% The Rust Guide
+
+<div style="border: 2px solid red; padding:5px;">
+This guide is a work in progress. Until it is ready, we highly recommend that
+you read the <a href="tutorial.html">Tutorial</a> instead. This work-in-progress Guide is being
+displayed here in line with Rust's open development policy. Please open any
+issues you find as usual.
+</div>
+
+Coming soon. :)

diff --git a/src/doc/tutorial.md b/src/doc/tutorial.md
index 91556b813781b12545182fbe2465283e92a90546..d5488ecc85d95bd095f6b4d478e0eb880ab2d90e 100644 (file)
--- a/src/doc/tutorial.md
+++ b/src/doc/tutorial.md
@@ -1,5 +1,12 @@
 % The Rust Language Tutorial
 
+<div style="border: 2px solid red; padding:5px;">
+The tutorial is undergoing a complete re-write as <a href="guide.html">the Guide</a>.
+Until it's ready, this tutorial is the right place to come to start learning
+Rust.  Please submit improvements as pull requests, but understand that
+eventually it will be going away.
+</div>
+
 # Introduction
 
 Rust is a programming language with a focus on type safety, memory