diff --git a/docs/chapter1/advanced/powerful-electrode-tools/electrode-explorer.md b/docs/chapter1/advanced/powerful-electrode-tools/electrode-explorer.md index ec873bc4d..07b958e4e 100644 --- a/docs/chapter1/advanced/powerful-electrode-tools/electrode-explorer.md +++ b/docs/chapter1/advanced/powerful-electrode-tools/electrode-explorer.md @@ -130,7 +130,7 @@ GHACCESS_TOKEN=YOUR_GITHUB_TOKEN NODE_ENV=production node . ## Deploy -Since this is an Electrode application, it can be deployed the same way as any other Electrode app. You can use [Heroku](/docs/chapter1/further-develop-app/deploy-your-app) by following the steps in our Quick Start or use the [More Deployments](/docs/chapter1/intermediate/more-deployments) as a resource. +Since this is an Electrode application, it can be deployed the same way as any other Electrode app. You can use [Heroku](/chapter1/further-develop-app/deploy-your-app.md) by following the steps in our Quick Start or use the [More Deployments](/chapter1/intermediate/more-deployments.md) as a resource. \*Just remember to set your GitHub token as an environment variable. diff --git a/docs/chapter1/advanced/stand-alone-modules/confippet.md b/docs/chapter1/advanced/stand-alone-modules/confippet.md index 8408c42b2..862dcd72b 100644 --- a/docs/chapter1/advanced/stand-alone-modules/confippet.md +++ b/docs/chapter1/advanced/stand-alone-modules/confippet.md @@ -34,7 +34,7 @@ $ npm install --save electrode-confippet ## Usage * [Getting Started](#getting-started) -* [configuration Composition](#config-composition) +* [Configuration Composition](#config-composition) * [Environment Variables](#environment-variables) * [Using Templates](#using-templates) * [Usage in Node Modules](#usage-in-node-modules) diff --git a/docs/chapter1/advanced/stand-alone-modules/redux-router-engine.md b/docs/chapter1/advanced/stand-alone-modules/redux-router-engine.md index 582afdbe8..f69447bca 100644 --- a/docs/chapter1/advanced/stand-alone-modules/redux-router-engine.md +++ b/docs/chapter1/advanced/stand-alone-modules/redux-router-engine.md @@ -20,7 +20,7 @@ The Electrode Redux Router Engine is a tool that handles asynchronous data for R - [Route Redux Init Example](#route-redux-init-example) - [`options` param](#options-param) - [More Route Redux Init Details](#more-route-redux-init-details) -- [Redux Router Engine](#redux-router-engine) +- [Redux Router Engine](#the-redux-router-engine) - [Electrode](#electrode) - [Hapi/Express](#hapiexpress) - [Redirect](#redirect) @@ -212,9 +212,9 @@ export default function reduxInit(options) { - In both cases you either have to manually process results from your child routes in `options.inits`, or you do every thing in the top route's `init` only. -## Redux Router Engine +## The Redux Router Engine -The [redux-router engine](#redux-router-engine) is initialized by passing a set of [options](#apis) including [your react router routes](#define-your-routes) definition. +The Redux Router Engine is initialized by passing a set of [options](#apis) including [your react router routes](#define-your-routes) definition. The `ReduxRouterEngine` is stand-alone and can be used in **any** Redux/React application that runs on Express, Hapi or [WalmartLab's Electrode Platform](http://www.electrode.io/). Here's how to configure the engine depending on your framework: diff --git a/docs/chapter1/advanced/stand-alone-modules/stateless-csrf-validation.md b/docs/chapter1/advanced/stand-alone-modules/stateless-csrf-validation.md index 757e331b2..c6bfb9b1c 100644 --- a/docs/chapter1/advanced/stand-alone-modules/stateless-csrf-validation.md +++ b/docs/chapter1/advanced/stand-alone-modules/stateless-csrf-validation.md @@ -66,7 +66,7 @@ Other configuration properties are optional and follow the [same usage as jsonwe ### Electrode {#stateless-validation-electrode} -All server configurations in [Electrode apps](/docs/overview/what-is-electrode) are handled by the versatile [confippet](./confippet.md) module. The Stateless CSRF JWT Validation module can be easily configured by adding the following property to `config/default.json`: +All server configurations in [Electrode apps](/overview/what-is-electrode.md) are handled by the versatile [confippet](./confippet.md) module. The Stateless CSRF JWT Validation module can be easily configured by adding the following property to `config/default.json`: ``` { diff --git a/docs/chapter1/advanced/you-can-view-an-example-bundleanalyzetsv-output-using-the-electrode-boilerplate-code.md b/docs/chapter1/advanced/you-can-view-an-example-bundleanalyzetsv-output-using-the-electrode-boilerplate-code.md index f6e447cbf..bef19587c 100644 --- a/docs/chapter1/advanced/you-can-view-an-example-bundleanalyzetsv-output-using-the-electrode-boilerplate-code.md +++ b/docs/chapter1/advanced/you-can-view-an-example-bundleanalyzetsv-output-using-the-electrode-boilerplate-code.md @@ -2,7 +2,7 @@ ### Maximum Performance Out-of-the-Box -In our **Getting Started** section, we introduced you to our Yeoman Electrode [Generator](https://github.com/electrode-io/electrode#yeoman-generator) and we constructed an impressive application with the built in technologies that the simple `yo electrode` command gave us (read our Getting Started: [What's Inside](/docs/chapter1/further-develop-app/whats-inside) to learn more): +In our **Getting Started** section, we introduced you to our Yeoman Electrode [Generator](https://github.com/electrode-io/electrode#yeoman-generator) and we constructed an impressive application with the built in technologies that the simple `yo electrode` command gave us (read our Getting Started: [What's Inside](/chapter1/further-develop-app/whats-inside.md) to learn more): - [React](https://facebook.github.io/react/index.html) @@ -38,7 +38,7 @@ In our **Getting Started** section, we introduced you to our Yeoman Electrode [G This is the beginning foundation of the Electrode Boilerplate. You have learned in the [Stand Alone Modules](./stand-alone-modules.md) section that each of the Electrode modules are agnostic and can be used individually to enhance one specific area of your application. However, integrated together, you have a supercharged application; one that is capable of handling the complex problems we face at WalmartLabs and reach maximum efficiency and performance. -This boilerplate includes the [Electrode Generator](/docs/chapter1/further-develop-app/whats-inside) and it also has the following stand-alone modules and tools built in for peak optimization right out-of-the-box: +This boilerplate includes the [Electrode Generator](/chapter1/further-develop-app/whats-inside.md) and it also has the following stand-alone modules and tools built in for peak optimization right out-of-the-box: - [Above the Fold Rendering](./stand-alone-modules/above-the-fold-rendering.md) - [Server Side Render Cache + Profiling](./stand-alone-modules/server-side-render-caching-+-profiling.md) diff --git a/docs/chapter1/further-develop-app/deploy-your-app.md b/docs/chapter1/further-develop-app/deploy-your-app.md index d7e5558ba..5f1dc0cf8 100644 --- a/docs/chapter1/further-develop-app/deploy-your-app.md +++ b/docs/chapter1/further-develop-app/deploy-your-app.md @@ -135,4 +135,4 @@ Visit the app at the generated URL by using this command: $ heroku open ``` -And...you did it! Click [here](https://first-electrode-example-app.herokuapp.com/) for our deployed Heroku version. We will build even more in our [Getting Started: Intermediate](../Intermediate) and cover complex topics like routing, server plugins, and other powerful deployment software. +And...you did it! Click [here](https://first-electrode-example-app.herokuapp.com/) for our deployed Heroku version. We will build even more in our [Getting Started: Intermediate](/chapter1/intermediate/README.md) and cover complex topics like routing, server plugins, and other powerful deployment software. diff --git a/docs/chapter1/Intermediate.md b/docs/chapter1/intermediate/README.md similarity index 100% rename from docs/chapter1/Intermediate.md rename to docs/chapter1/intermediate/README.md diff --git a/docs/chapter1/intermediate/build-a-server-plugin.md b/docs/chapter1/intermediate/build-a-server-plugin.md index 3c5085be9..4d984c94b 100644 --- a/docs/chapter1/intermediate/build-a-server-plugin.md +++ b/docs/chapter1/intermediate/build-a-server-plugin.md @@ -121,4 +121,4 @@ Set your token for heroku deployment: heroku config:set token='your-token-here' ``` -A great tool for testing your server requests is [Postman](https://www.getpostman.com/). Its user interface for viewing response objects and errors is incredible. For now, we will build out Your Awesome App. Navigate to [Intermediate: Add Routes](/docs/chapter1/intermediate/react-routes/add-routes), to add routing to the app and extend our UI to display our contributor array. +A great tool for testing your server requests is [Postman](https://www.getpostman.com/). Its user interface for viewing response objects and errors is incredible. For now, we will build out Your Awesome App. Navigate to [Intermediate: Add Routes](/chapter1/intermediate/react-routes/add-routes.md) to add routing to the app and extend our UI to display our contributor array. diff --git a/docs/chapter1/intermediate/component-archetype/README.md b/docs/chapter1/intermediate/component-archetype/README.md index b64ec69c3..85a14fd7c 100644 --- a/docs/chapter1/intermediate/component-archetype/README.md +++ b/docs/chapter1/intermediate/component-archetype/README.md @@ -2,4 +2,4 @@ The Electrode Component Archetype helps developers quickly build React components. Recently, the WalmartLabs Electrode team made a significant restructure to the component directory using Lerna to manage the component structure. With the new structure, you can have multiple components inside the package directory and a single demo app to test all the components. Generally, you keep one component in one repo, but you can also have multiple smaller components that complement each other. We also moved demo-server to a directory outside of the packages, imported components from packages, and presented components using the demo app. -Let's go through the most important sections to understand the new Component Archetype together and we will cover how to generate Electrode components by using the latest Electrode generators in the [Create an Electrode Component](/docs/chapter1/intermediate/create-a-electrode-component) section. +Let's go through the most important sections to understand the new Component Archetype together and we will cover how to generate Electrode components by using the latest Electrode generators in the [Create an Electrode Component](/chapter1/intermediate/create-a-electrode-component.md) section. diff --git a/docs/chapter1/intermediate/component-archetype/component-archetype-structure.md b/docs/chapter1/intermediate/component-archetype/component-archetype-structure.md index 28881e6c6..2ffc026e2 100644 --- a/docs/chapter1/intermediate/component-archetype/component-archetype-structure.md +++ b/docs/chapter1/intermediate/component-archetype/component-archetype-structure.md @@ -2,7 +2,7 @@ In the previous component archetype, we used `demo-server` to demo and test the React component inside of the component itself, which adds a risk of confusion. To clarify, we removed `demo-server` for the component archetype to target the build, eslint check, and unit tests. -At the same time, in the [new electrode components](/docs/chapter1/intermediate/create-a-electrode-component), we demonstrate components using `/demo-app` where we import components from `/packages/`. The latest electrode components can be generated by the latest electrode-generator. +At the same time, in the [new electrode components](/chapter1/intermediate/create-a-electrode-component.md), we demonstrate components using `/demo-app` where we import components from `/packages/`. The latest electrode components can be generated by the latest electrode-generator. The new structure of the Electrode React Component Archetype is shown below. @@ -38,4 +38,4 @@ The new structure of the Electrode React Component Archetype is shown below. ... ``` -The Component Archetype still provides babel, eslint, karma and webpack configuration files as before, and the files can be found in the `electrode-archetype-react-component/config` directory. But there are some updates for the webpack configuration files, which can be found in the [Webpack Configuration](/docs/chapter1/intermediate/component-archetype/webpack-config) section. +The Component Archetype still provides babel, eslint, karma and webpack configuration files as before, and the files can be found in the `electrode-archetype-react-component/config` directory. But there are some updates for the webpack configuration files, which can be found in the [Webpack Configuration](./webpack-config.md) section. diff --git a/docs/chapter1/intermediate/component-archetype/webpack-config.md b/docs/chapter1/intermediate/component-archetype/webpack-config.md index 2fc5eaa43..96031a606 100644 --- a/docs/chapter1/intermediate/component-archetype/webpack-config.md +++ b/docs/chapter1/intermediate/component-archetype/webpack-config.md @@ -35,4 +35,4 @@ Below are the partial configurations for a new component archetype webpack struc --- -After understanding the new Component Archetype Structure, it's time to generate Electrode components by using the latest Electrode generators. With `generator-electrode`, we can create dynamic and performant Lerna-structured Electrode components. Let's explore and personalize this in our next section, [Create an Electrode Component.](../create-a-electrode-component) +After understanding the new Component Archetype Structure, it's time to generate Electrode components by using the latest Electrode generators. With `generator-electrode`, we can create dynamic and performant Lerna-structured Electrode components. Let's explore and personalize this in our next section, [Create an Electrode Component.](/chapter1/intermediate/create-a-electrode-component.md) diff --git a/docs/chapter1/intermediate/server-config.md b/docs/chapter1/intermediate/server-config.md index d85e8ecd1..01c252f2c 100644 --- a/docs/chapter1/intermediate/server-config.md +++ b/docs/chapter1/intermediate/server-config.md @@ -79,6 +79,6 @@ When all of our guests are invited to the House Party, our CSS modules kick in a Feel free to add your own personal touch and build out your Resource List House Party. You can compare your work to our [Heroku deployed example app](https://electrode-example-app.herokuapp.com/). -When you're ready, you can deploy Your Awesome App to [Heroku](https://devcenter.heroku.com/categories/deployment) by following the previous steps in our [Getting Started: Build More](../../chapter1/further-develop-app/build-app.md) section. If you choose this step, make sure you set all of the Heroku configurations, including the one for our [GitHub Api](../../chapter1/intermediate/build-a-server-plugin.md). +When you're ready, you can deploy Your Awesome App to [Heroku](https://devcenter.heroku.com/categories/deployment) by following the previous steps in our [Getting Started: Build More](/chapter1/further-develop-app/build-app.md) section. If you choose this step, make sure you set all of the Heroku configurations, including the one for our [GitHub Api](./build-a-server-plugin.md). -You can also navigate to [Intermediate: More Deployments](more-deployments.md) to learn how to deploy with [Docker](./more-deployments/docker.md) and [Kubernetes](./more-deployments/kubernetes.md). +You can also navigate to [Intermediate: More Deployments](./more-deployments.md) to learn how to deploy with [Docker](./more-deployments/docker.md) and [Kubernetes](./more-deployments/kubernetes.md).