migrated Redirect doc

Author: ryanflorence

docs/README.md

@@ -7,5 +7,7 @@
 - [Confirming Navigation](ConfirmingNavigation.md)
 - [Glossary](Glossary.md)
 - [Route](Route.md)
+- [Plain Route](Plain Route.md)
+- [Redirect](Redirect.md)
 
 - [Server Rendering](ServerRendering.md)

doc/01 Route Configuration/Redirect.md renamed to docs/Redirect.md

@@ -1,56 +1,41 @@
+## Redirect
+
 A `Redirect` sets up a redirect to another route in your application to
 maintain old URLs.
 
-Props
------
+### Props
 
-### `from`
+#### `from`
 
 The path you want to redirect from, including dynamic segments.
 
-### `to`
-
-The route path you want to redirect to.
-
-### `params`
+#### `to`
 
-By default, the parameters will just pass through to the new route, but
-you can specify them if you need to (usually you shouldn't).
+The path you want to redirect to.
 
-### `query`
+#### `query`
 
-By default, the query parameters will just pass through to the new
-route, but you can specify them if you need to (usually you shouldn't).
+By default, the query parameters will just pass through but you can
+specify them if you need to.
 
-Example
--------
+### Example
 
 ```js
 // lets say we want to change from `/profile/123` to `/about/123`
 // and redirect `/get-in-touch` to `/contact`
 <Route component={App}>
-  <Route path="contact" component={Contact}/>
   <Route path="about/:userId" component={UserProfile}/>
-  <Route path="course/:courseId">
-    <Route path="dashboard" component={Dashboard}/>
-    <Route path="assignments" component={Assignments}/>
-  </Route>
-
-  {/* `/get-in-touch` -> `/contact` */}
-  <Redirect from="/get-in-touch" to="/contact" />
 
   {/* `/profile/123` -> `/about/123` */}
   <Redirect from="/profile/:userId" to="/about/:userId" />
-
-  {/* `/profile/me` -> `/about/123` */}
-  <Redirect from="/profile/me" to="/about/:userId" params={{userId: SESSION.USER_ID}}/>
 </Route>
 ```
 
 Note that the `<Redirect/>` can be placed anywhere in the route
 hierarchy, if you'd prefer the redirects to be next to their respective
 routes, the `from` path will match the same as a regular route `path`.
-Currently, the `to` property of `<Redirect/>` needs to be an absolute path.
+Currently, the `to` property of `<Redirect/>` needs to be an absolute
+path. Pull requests welcome to make them handle relative paths too!
 
 ```js
 <Route path="course/:courseId">
@@ -59,3 +44,4 @@ Currently, the `to` property of `<Redirect/>` needs to be an absolute path.
   <Redirect from="home" to="/course/:courseId/dashboard" />
 </Route>
 ```
+

modules/Redirect.js

@@ -44,7 +44,7 @@ var Redirect = React.createClass({
     }
 
   },
-  
+
   propTypes: {
     path: string,
     from: string, // Alias for path
@@ -61,7 +61,7 @@ var Redirect = React.createClass({
       '<Redirect> elements are for router configuration only and should not be rendered'
     );
   }
-  
+
 });
 
 export default Redirect;