docs(server): update server guides to 1.0

.github/workflows/check_guides.sh

@@ -1,37 +1,50 @@
 #!/bin/sh
 
-if [ ! -e tmp/Cargo.toml ]; then
-    if [ ! -d tmp ]; then
-        cargo new tmp
-    else
-        cargo init tmp
-    fi
-    cat >> tmp/Cargo.toml <<-EOF
-futures = "0.3"
-hyper = { version = "0.14", features = ["full"] }
-hyper-tls = "0.5"
-tokio = { version = "1", features = ["full"] }
+for value in legacy stable
+do
+    if [ ! -e "$value/Cargo.toml" ]; then
+        if [ ! -d $value ]; then
+            cargo new $value
+        else
+            cargo init $value
+        fi
+        if [ $value = legacy ]; then
+            cat >> "$value/Cargo.toml" <<-EOF
+    futures = "0.3"
+    hyper = { version = "0.14", features = ["full"] }
+    hyper-tls = "0.5"
+    tokio = { version = "1", features = ["full"] }
 EOF
-    cargo build --manifest-path tmp/Cargo.toml
-fi
-
-test_file() {
-    echo "Testing: $f"
-    rustdoc --edition 2018 --test $1 -L tmp/target/debug/deps
-}
+            cargo build --manifest-path "$value/Cargo.toml"
+        fi
+        if [ $value = stable ]; then
+            cat >> "$value/Cargo.toml" <<-EOF
+    hyper = { version = "1.0.0-rc.1", features = ["full"] }
+    tokio = { version = "1", features = ["full"] }
+    http-body-util = "0.1.0-rc.1" 
+EOF
+            cargo build --manifest-path "$value/Cargo.toml"
+        fi
+    fi
 
-if [ -n "$1" ]; then
-    test_file $1
-    exit $?
-fi
+    test_file() {
+        echo "Testing: $f"
+        rustdoc --edition 2018 --test $1 -L "$value/target/debug/deps"
+    }
 
-status=0
-for f in `git ls-files | grep '\.md$'`; do
-    test_file $f
-    s=$?
-    if [ "$s" != "0" ]; then
-        status=$s
+    if [ -n "$1" ]; then
+        test_file $1
+        exit $?
     fi
+
+    status=0
+    for f in `git ls-files | grep "^_$value\/.*\.md$"`; do
+        test_file $f
+        s=$?
+        if [ "$s" != "0" ]; then
+            status=$s
+        fi
+    done
 done
 
 exit $status

.gitignore

@@ -1,4 +1,5 @@
 Gemfile*
 _site*
 .sass-cache
-tmp/
+/legacy
+/stable

_config.yml

@@ -6,14 +6,25 @@ url: "https://hyper.rs" # the base hostname & protocol for your site
 defaults:
   -
     scope:
-      path: "_guides"
+      path: "_legacy/"
       type: "guides"
     values:
       layout: "guide"
+  -
+
+    scope:
+      path: "_stable/"
+      type: "guides"
+    values:
+      layout: "guide"
+
 
 collections:
-  guides:
-    permalink: /:collection/:path/
+  legacy:
+    permalink: /guides/0.14/:path/
+    output: true
+  stable:
+    permalink: /guides/1/:path/
     output: true
   posts:
     permalink: /blog/:year/:month/:day/:title/
@@ -31,7 +42,13 @@ relative_links:
   enabled: true
   collections: true
 
-docs_url: https://docs.rs/hyper/0.14.*
+plugins:
+  - jekyll-redirect-from
+
+docs_url: https://docs.rs/hyper/1.0.0-rc.1
 examples_url: https://github.com/hyperium/hyper/tree/master/examples
 futures_url: https://docs.rs/futures/0.3.*
 hyper_tls_url: https://docs.rs/hyper-tls/*
+
+legacy_docs_url: https://docs.rs/hyper/0.14.23
+legacy_examples_url: https://github.com/hyperium/hyper/tree/0.14.x/examples

_data/stable.yml

@@ -0,0 +1,19 @@
+- title: Guide
+  path: ""
+  guides:
+  - server
+  - client
+
+- title: Server
+  path: "/server"
+  guides:
+  - hello-world
+  - echo
+  - graceful-shutdown
+
+- title: Client
+  path: "/client"
+  guides:
+  - basic
+  - advanced
+  - configuration

_includes/guide_ul.html

@@ -2,10 +2,18 @@
 <section class="guide-topic">
   <h4 class="guide-topic-title">{{ topic.title }}</h4>
   <ul class="nav">
-  {% for guide in  topic.guides %}
-    {% assign guide_url = guide | prepend:"/" | prepend: topic.path | prepend:"/guides" | append:"/" %}
-    {% assign p = site.guides | where:"url", guide_url | first %}
-    <li {% if guide_url == page.url %}class="active"{% endif %}><a href="{{ p.url }}">{{ p.title }} </a></li>
-  {% endfor %}
+  {% if page.collection == "legacy" %}
+    {% for guide in  topic.guides %}
+      {% assign guide_url = guide | prepend:"/" | prepend: topic.path | prepend:"/guides/0.14" | append:"/" %}
+      {% assign p = site.legacy | where:"url", guide_url | first %}
+      <li {% if guide_url == page.url %}class="active"{% endif %}><a href="{{ p.url }}">{{ p.title }} </a></li>
+    {% endfor %}
+  {% elsif page.collection == "stable" %}
+    {% for guide in  topic.guides %}
+      {% assign guide_url = guide | prepend:"/" | prepend: topic.path | prepend:"/guides/1" | append:"/" %}
+      {% assign p = site.stable | where:"url", guide_url | first %}
+      <li {% if guide_url == page.url %}class="active"{% endif %}><a href="{{ p.url }}">{{ p.title }} </a></li>
+    {% endfor %}
+  {% endif %}
   </ul>
-</section>
+</section>

_includes/header.html

@@ -5,7 +5,8 @@
         <li class="nav-item">
           <a class="navbar-brand" href="/">hyper.rs</a>
         </li>
-        <li class="nav-item"><a class="nav-link" href="/guides">Guides</a></li>
+        <li class="nav-item"><a class="nav-link" href="/guides/1">1.0 Guides</a></li>
+        <li class="nav-item"><a class="nav-link" href="/guides/0.14">0.14 Guides</a></li>
         <li class="nav-item"><a class="nav-link" href="https://github.com/hyperium/hyper">Source</a></li>
       </ul>
     </div>

_layouts/guide.html

@@ -14,14 +14,27 @@ <h1>{{ page.title }}</h1>
       <div class="row">
         <aside class="col-md-3 hyper-sidebar">
           <nav>
-            {% assign topics = site.data.guides | first %}
-            {% for guides in topics.guides %}
-            {% assign topic_sub_url = guides | prepend:"/" %}
-            {% assign topic = site.data.guides | where: "path", topic_sub_url | first %}
-            {% include guide_ul.html topic=topic %}
-            {% endfor %}
+            {% if page.collection == "legacy" %}
+              {% assign topics = site.data.legacy | first %}
+              {% for guides in topics.guides %}
+                {% assign topic_sub_url = guides | prepend:"/" %}
+                {% assign topic = site.data.legacy | where: "path", topic_sub_url | first %}
+                {% include guide_ul.html topic=topic %}
+              {% endfor %}
+            {% elsif page.collection == "stable" %}
+              {% assign topics = site.data.stable | first %}
+              {% for guides in topics.guides %}
+                {% assign topic_sub_url = guides | prepend:"/" %}
+                {% assign topic = site.data.stable | where: "path", topic_sub_url | first %}
+                {% include guide_ul.html topic=topic %}
+              {% endfor %}
+            {% endif %}
             <h4 class="guide-topic-title">
-              <a href="{{ site.docs_url }}">API Reference</a>
+              {% if page.collection == "legacy" %}
+                <a href="{{ site.legacy_docs_url }}">API Reference</a>
+              {% elsif page.collection == "stable" %}
+                <a href="{{ site.docs_url }}">API Reference</a>
+              {% endif %}
             </h4>
           </nav>
         </aside>

_layouts/home.html

@@ -9,12 +9,19 @@
       <div class="container">
         <h1 class="hyper-logo">hyper</h1>
         <p>Fast and safe HTTP for the Rust language.</p>
-        <p><a href="/guides" class="btn hyper-getstarted">Get Started</a></p>
+        <p><a href="/guides/1" class="btn hyper-getstarted">Get Started</a></p>
       </div>
     </section>
     <section class="container">
-    <div class="row">
-      <div class="col-md-6">
+      <div class="row">
+        <div class="col-md-6">
+        <p class="lead">
+          <b>Note:</b> hyper is planning a stable <code>1.0</code> release at the end of January 2023.
+          These guides will be gradually transitioned to <code>1.0</code>, but if you're looking for
+          guides for <code>0.14</code> you can find them <a href="/guides/0.14">here</a>. If you'd like to
+          learn more about the move to <code>1.0</code>, 
+          <a href="https://seanmonstar.com/post/680802159018803200/hyper-10-roadmap">this</a> is a good place to start.
+        </p>
         <p class="lead">hyper is a fast HTTP implementation written in and for Rust.</p>
         <ul>
             <li>A <strong>Client</strong> for talking to web services.</li>

_guides/client/advanced.md → _legacy/client/advanced.md

@@ -1,5 +1,8 @@
 ---
 title: Advanced Client Usage
+layout: guide
+redirect_from: 
+    - /guides/client/advanced
 ---
 
 Once you've done all the setup in the [simple guide][], you probably
@@ -110,5 +113,5 @@ let (ip, headers) = futures::try_join!(ip_fut, headers_fut)?;
 ```
 
 [simple guide]: ./basic.md
-[Request]: {{ site.docs_url }}/hyper/struct.Request.html
-[Method]: {{ site.docs_url }}/hyper/struct.Method.html
+[Request]: {{ site.legacy_docs_url }}/hyper/struct.Request.html
+[Method]: {{ site.legacy_docs_url }}/hyper/struct.Method.html

_guides/client/basic.md → _legacy/client/basic.md

@@ -1,5 +1,8 @@
 ---
 title: Getting Started with a Client
+layout: guide
+redirect_from: 
+    - /guides/client/basic
 ---
 
 To start with, we'll just get a simple `GET` request to a webpage working,
@@ -112,9 +115,9 @@ while let Some(chunk) = resp.body_mut().data().await {
 
 And that's it! You can see the [full example here][example].
 
-[Client]: {{ site.docs_url }}/hyper/client/struct.Client.html
+[Client]: {{ site.legacy_docs_url }}/hyper/client/struct.Client.html
 [Tokio]: https://tokio.rs
 [Tokio-Futures]: https://tokio.rs/tokio/tutorial/async
-[StatusCode]: {{ site.docs_url }}/hyper/struct.StatusCode.html
-[Response]: {{ site.docs_url }}/hyper/struct.Response.html
-[example]: {{ site.examples_url }}/client.rs
+[StatusCode]: {{ site.legacy_docs_url }}/hyper/struct.StatusCode.html
+[Response]: {{ site.legacy_docs_url }}/hyper/struct.Response.html
+[example]: {{ site.legacy_examples_url }}/client.rs

_guides/client/configuration.md → _legacy/client/configuration.md

@@ -1,5 +1,8 @@
 ---
 title: Client Configuration
+layout: guide
+redirect_from: 
+    - /guides/client/configuration
 ---
 
 ## Using TLS
@@ -39,5 +42,5 @@ ideas of things that could be connectors:
 - Proxies
 - In-memory streams (such as for testing)
 
-[`Client`]: {{ site.docs_url }}/hyper/client/struct.Client.html
+[`Client`]: {{ site.legacy_docs_url }}/hyper/client/struct.Client.html
 [hyper-tls]: {{ site.hyper_tls_url }}

_guides/client/index.md → _legacy/client/index.md

@@ -1,6 +1,8 @@
 ---
 title: Client Guides
-permalink: /guides/client/
+permalink: /0.14/client
+redirect_from: 
+    - /guides/client/
 ---
 
 This is just placeholder page. It should probably become a table of

_guides/index.md → _legacy/index.md

@@ -1,7 +1,9 @@
 ---
 title:  Getting Started
 layout: guide
-permalink: /guides/
+permalink: /guides/0.14/
+redirect_from: 
+    - /guides/
 ---
 
 hyper is an HTTP library for the Rust language.
@@ -18,6 +20,6 @@ hyper = "0.14"
 
 You could also look at the [generated API documentaton][docs].
 
-[docs]: {{ site.docs_url }}
+[docs]: {{ site.legacy_docs_url }}
 [Server guide]: server/hello-world.md
 [Client guide]: client/basic.md

_guides/server/echo.md → _legacy/server/echo.md

@@ -1,5 +1,8 @@
 ---
 title: Echo, echo, echo
+layout: guide
+redirect_from: 
+    - /guides/server/echo
 ---
 
 You already have a [Hello World server](hello-world.md)? Excellent! Usually,
@@ -197,5 +200,5 @@ We want to concatenate the request body, and map the result into our `reverse` f
 
 You can see a compiling [example here][example].
 
-[example]: {{ site.examples_url }}/echo.rs
+[example]: {{ site.legacy_examples_url }}/echo.rs
 [future-crate]: https://github.com/rust-lang-nursery/futures-rs

_guides/server/graceful-shutdown.md → _legacy/server/graceful-shutdown.md

@@ -1,6 +1,8 @@
 ---
 title:  Gracefully Shutdown a Server
 layout: guide
+redirect_from: 
+    - /guides/server/graceful-shutdown
 ---
 
 hyper `Server`s have the ability to "gracefully" shutdown. This means stopping to accept new requests, and shutting down once all in-progress requests have completed.

_guides/server/hello-world.md → _legacy/server/hello-world.md

@@ -1,6 +1,8 @@
 ---
 title:  Getting Started with a Server
 layout: guide
+redirect_from: 
+    - /guides/server/hello-world
 ---
 
 Let's start by making a "Hello, World!" server, and expand from there.
@@ -94,5 +96,5 @@ async fn main() {
 
 To see all the snippets put together, check out the [full example][example]!
 
-[service]: {{ site.docs_url }}/hyper/service/trait.Service.html
-[example]: {{ site.examples_url }}/hello.rs
+[service]: {{ site.legacy_docs_url }}/hyper/service/trait.Service.html
+[example]: {{ site.legacy_examples_url }}/hello.rs

_legacy/server/index.md

@@ -0,0 +1,9 @@
+---
+title: Server Guides
+permalink: /0.14/server
+redirect_from: 
+    - /guides/server/
+---
+
+This is just placeholder page. It should probably become a table of
+contents for the server guides.