Skip to content
Permalink
Browse files

docs(tutorial): add deprecation notice to v1.4.x tutorial and point t…

…o the correct branch

- Add a deprecation notice on the 'index' page.
- Hide the "Live Demo" buttons (since we don't have a live demo).
- Update the GitHub diff links to point to the `1.4-snapshot` angular-phonecat branch.
- Modify all git commangs to use the appropriate branch and tags (e.g. `1.4-step-*`).

Related to #14416.

Closes #14675
  • Loading branch information
gkalpak committed May 25, 2016
1 parent f8103a8 commit 6234cda41cc1dc8c03fea369b4158643ab49b677
Showing with 28 additions and 9 deletions.
  1. +5 −7 docs/app/src/tutorials.js
  2. +22 −1 docs/content/tutorial/index.ngdoc
  3. +1 −1 docs/content/tutorial/step_00.ngdoc
@@ -11,8 +11,7 @@ angular.module('tutorials', [])
scope: {},
template:
'<a ng-href="tutorial/{{prev}}"><li class="btn btn-primary"><i class="glyphicon glyphicon-step-backward"></i> Previous</li></a>\n' +
'<a ng-href="http://angular.github.io/angular-phonecat/step-{{seq}}/app"><li class="btn btn-primary"><i class="glyphicon glyphicon-play"></i> Live Demo</li></a>\n' +
'<a ng-href="https://github.com/angular/angular-phonecat/compare/step-{{diffLo}}...step-{{diffHi}}"><li class="btn btn-primary"><i class="glyphicon glyphicon-search"></i> Code Diff</li></a>\n' +
'<a ng-href="https://github.com/angular/angular-phonecat/compare/1.4-step-{{diffLo}}...1.4-step-{{diffHi}}"><li class="btn btn-primary"><i class="glyphicon glyphicon-search"></i> Code Diff</li></a>\n' +
'<a ng-href="tutorial/{{next}}"><li class="btn btn-primary">Next <i class="glyphicon glyphicon-step-forward"></i></li></a>',
link: function(scope, element, attrs) {
var seq = 1 * attrs.docTutorialNav;
@@ -38,12 +37,11 @@ angular.module('tutorials', [])
'<p><button class="btn" ng-click="show=!show">Workspace Reset Instructions ➤</button></p>\n' +
'<div class="alert alert-info" ng-show="show">\n' +
' <p>Reset the workspace to step {{step}}.</p>' +
' <p><pre>git checkout -f step-{{step}}</pre></p>\n' +
' <p>Refresh your browser or check out this step online: '+
'<a href="http://angular.github.io/angular-phonecat/step-{{step}}/app">Step {{step}} Live Demo</a>.</p>\n' +
' <p><pre>git checkout -f 1.4-step-{{step}}</pre></p>\n' +
' <p>Refresh your browser to see the changes.</p>\n' +
'</div>\n' +
'<p>The most important changes are listed below. You can see the full diff on ' +
'<a ng-href="https://github.com/angular/angular-phonecat/compare/step-{{step ? (step - 1): \'0~1\'}}...step-{{step}}" title="See diff on Github">GitHub</a>\n' +
'<a ng-href="https://github.com/angular/angular-phonecat/compare/1.4-step-{{step ? (step - 1) : \'0~1\'}}...1.4-step-{{step}}" title="See diff on Github">GitHub</a>\n' +
'</p>'
};
});
});
@@ -5,6 +5,22 @@

# PhoneCat Tutorial App

<div class="alert alert-danger">
<p>
This version of the tutorial is deprecated and no longer maintained. You can find the most
recent version of the tutorial at https://docs.angularjs.org/tutorial/.
</p>
<p>
It is recommended to use the latest tutorial version for the following reasons:
<ul>
<li>It showcases features introduced in AngularJS v1.5+</li>
<li>It follows modern best practices in terms of architecture and code organization</li>
<li>It has more up-to-date dependencies and tools</li>
<li>It is actively maintained</li>
</ul>
</p>
</div>

A great way to get introduced to AngularJS is to work through this tutorial, which walks you through
the construction of an AngularJS web app. The app you will build is a catalog that displays a list
of Android devices, lets you filter the list to see only devices that interest you, and then view
@@ -73,7 +89,7 @@ Clone the [angular-phonecat repository][angular-phonecat] located at GitHub by r
command:

```
git clone --depth=14 https://github.com/angular/angular-phonecat.git
git clone --depth=14 --branch=1.4-snapshot https://github.com/angular/angular-phonecat.git
```

This command creates the `angular-phonecat` directory in your current directory.
@@ -82,6 +98,11 @@ This command creates the `angular-phonecat` directory in your current directory.
download much smaller and faster.
</div>

<div class="alert alert-info">
The `--branch=1.4-snapshot` option tells Git to pull down the `1.4-snapshot` branch.
The code for this older version of the tutorial is on that branch.
</div>

Change your current directory to `angular-phonecat`.

```
@@ -16,7 +16,7 @@ dependencies, as described in {@link index#get-started Get Started}.
In the `angular-phonecat` directory, run this command:

```
git checkout -f step-0
git checkout -f 1.4-step-0
```


0 comments on commit 6234cda

Please sign in to comment.
You can’t perform that action at this time.