Skip to content

Commit ad93e42

Browse files
doc(all): working on re-organizing some docs content
1 parent 85634b6 commit ad93e42

File tree

5 files changed

+38
-17
lines changed

5 files changed

+38
-17
lines changed
File renamed without changes.

doc/article/en-US/bundling-your-app-for-deploy.md renamed to doc/article/en-US/jspm-bundling.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
{
3-
"name": "Bundling Your App for Deploy",
3+
"name": "JSPM Bundling",
44
"culture": "en-US",
55
"description": "Before deploying your app to production, you'll want to bundle the assets for efficient use of the network.",
66
"engines" : { "aurelia-doc" : "^1.0.0" },
@@ -33,9 +33,9 @@ To make this process efficient, we need to compress the assets and make fewer (p
3333

3434
Bundling along with minification are techniques that can also be used to improve load time. Bundling and minification improve load time by reducing the number of requests to the server as well as reducing the size of requested assets such as views, view-models and CSS.
3535

36-
## [Bundling an Aurelia Application](aurelia-doc://section/3/version/1.0.0)
36+
## [Bundling an Aurelia JSPM Application](aurelia-doc://section/3/version/1.0.0)
3737

38-
We can use [Aurelia Bundler](http://github.com/aurelia/bundler) to create a gulp task for bundling our app. Let's jump right into it. We will use the `skeleton-navigation` as our app to bundle. If you don't have that set up. Follow [these steps](https://github.com/aurelia/skeleton-navigation#running-the-app).
38+
We can use [Aurelia Bundler](http://github.com/aurelia/bundler) to create a gulp task for bundling our JSPM app. Let's jump right into it. We will use the `skeleton-navigation` as our app to bundle. If you don't have that set up. Follow [these steps](https://github.com/aurelia/skeleton-navigation#running-the-app).
3939

4040
Now that we have our app running, let's start by installing `aurelia-bundler`. To do so `cd` into `skeleton-navigation` and run the following command:
4141

doc/article/en-US/a-production-setup.md renamed to doc/article/en-US/jspm-setup.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
{
3-
"name": "A Production Setup",
3+
"name": "JSPM Setup",
44
"culture": "en-US",
5-
"description": "If you've completed the Getting Started guide and have had some time to play around with Aurelia, you're probably ready to start building a real application. This guide will help you to get set up with a production-ready starter-kit and show you how to accomplish a few common tasks.",
5+
"description": "If you're interested in getting setup with JSPM to build projects, this article will take you through setting up both your machine and a production quality starter project.",
66
"engines" : { "aurelia-doc" : "^1.0.0" },
77
"author": {
88
"name": "Rob Eisenberg",
@@ -32,9 +32,6 @@ Next, we need to install [jspm](http://jspm.io/). This will serve as our client-
3232
npm install -g jspm
3333
```
3434

35-
> Info
36-
> Don't want to use jspm? No problem. All Aurelia packages are available via [Bower](http://bower.io/), GitHub and NPM.
37-
3835
## [Setting up the Project Structure and Build](aurelia-doc://section/2/version/1.0.0)
3936

4037
With the tooling installed, we can now turn our attention to setting up a basic structure for your app. We'll begin by downloading a skeleton. We've got several versions available for you based on your language and tooling preferences. Please download the latest skeletons now.
@@ -43,20 +40,20 @@ With the tooling installed, we can now turn our attention to setting up a basic
4340
<a class="au-button" href="https://github.com/aurelia/skeleton-navigation/releases/latest" style="text-decoration: none; margin: 32px 8px 42px 8px;" target="_blank">Download the Skeletons</a>
4441
</div>
4542

46-
Once the download has completed, unzip it and look inside. The readme file contained therein will explain the various options available to you. Please select one of the skeletons and copy it to the location on your file system that you wish your code to reside. Be sure to rename the folder to appropriately represent the app you want to build. Based on your selection, you'll want to configure this documentation to show the appropriate programming language for all samples. Look at the top of this page. You will see a language selector. Be sure to select the language that matches the package that you downloaded.
43+
Once the download has completed, unzip it and look inside. The readme file contained therein will explain the various options available to you. Please select one of the skeletons and copy it to the location on your file system that you wish your code to reside. Be sure to rename the folder to appropriately represent the app you want to build.
4744

4845
You will now find everything you need inside the folder, including a basic build, package configuration, styles and more. With all this in place, let's run some commands.
4946

5047
1. Open a console and change directory into your app's directory.
51-
2. Execute the following command to install the Gulp plugins listed in the _devDependencies_ section of the package manifest:
48+
2. Execute the following command to install the dependencies listed in the _devDependencies_ section of the package manifest:
5249
```shell
5350
npm install
5451
```
5552
3. Next, execute the following command to install the Aurelia libraries, bootstrap and font-awesome, listed in the _jspm.dependencies_ section of the package manifest:
5653
```shell
5754
jspm install -y
5855
```
59-
Everything we've done so far is standard Node.js build and package management procedures. It doesn't have anything specific to do with Aurelia itself. We're just walking you through setting up a modern ${context.language.name} project and build configuration from scratch. You may be familiar with this already, but if not then welcome to this new and exciting world!
56+
Everything we've done so far is standard Node.js build and package management procedures. It doesn't have anything specific to do with Aurelia itself. We're just walking you through setting up a modern ${context.language.name} project and build configuration from scratch.
6057

6158
> Info
6259
> Bootstrap and Font-Awesome are **not** dependencies of Aurelia. We only leverage them as part of the starter kit in order to help you quickly achieve a decent look out-of-the-box. You can easily replace them with whatever your favorite CSS framework and/or icon library is.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
{
3+
"name": "The Aurelia CLI",
4+
"culture": "en-US",
5+
"description": "Learn how to get setup with the Aurelia CLI and use its basic capabilities.",
6+
"engines" : { "aurelia-doc" : "^1.0.0" },
7+
"author": {
8+
"name": "Rob Eisenberg",
9+
"url": "http://robeisenberg.com"
10+
},
11+
"contributors": [],
12+
"translators": [],
13+
"keywords": ["Getting Started", "ES2015", "ES2016", "TypeScript"]
14+
}
15+
---
16+
## [Getting Setup](aurelia-doc://section/1/version/1.0.0)

package.json

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,20 @@
126126
"href": "doc/article/en-US/quick-start.md"
127127
},
128128
{
129-
"title": "A Production Setup",
130-
"href": "doc/article/en-US/a-production-setup.md"
129+
"title": "Contact Manager Tutorial",
130+
"href": "doc/article/en-US/contact-manager-tutorial.md"
131+
},
132+
{
133+
"title": "The Aurelia CLI",
134+
"href": "doc/article/en-US/the-aurelia-cli.md"
135+
},
136+
{
137+
"title": "JSPM Setup",
138+
"href": "doc/article/en-US/jspm-setup.md"
139+
},
140+
{
141+
"title": "JSPM Bundling",
142+
"href": "doc/article/en-US/jspm-bundling.md"
131143
},
132144
{
133145
"title": "Creating Components",
@@ -141,10 +153,6 @@
141153
"title": "Securing Your App",
142154
"href": "doc/article/en-US/securing-your-app.md"
143155
},
144-
{
145-
"title": "Bundling Your App for Deploy",
146-
"href": "doc/article/en-US/bundling-your-app-for-deploy.md"
147-
},
148156
{
149157
"title": "Cheat Sheet",
150158
"href": "doc/article/en-US/cheat-sheet.md"

0 commit comments

Comments
 (0)