docs cleanup and improvements

- moving 'downloading' from devguide to "misc"
- syncing the latest version of 'downloading'
- getting rid of junk files
This commit is contained in:
Igor Minar 2011-03-02 23:14:13 -08:00
parent cd139f5767
commit dea72be0cc
4 changed files with 70 additions and 459 deletions

70
docs/downloading.ngdoc Normal file
View file

@ -0,0 +1,70 @@
@workInProgress
@ngdoc overview
@name Downloading
@description
# Including angular scripts from code.angularjs.org
To get started quickly you without worrying about downloading anything and maintaining a local copy,
you can point your html `script` tag directly to <http://code.angularjs.org/> urls.
There are two kinds of urls you care about:
* http://code.angularjs.org/angular-<version>.js
* http://code.angularjs.org/angular-<version>.min.js
The first one is non-minified version, suitable for web development. The latter one is minified
version, which we strongly suggest you use in production.
To point your code to let's say angular version 0.9.12, use the following template:
<pre>
<!doctype html>
<html>
<head>
<title>My Angular App</title>
<script src="http://code.angularjs.org/angular-0.9.12.js" ng:autobind></script>
</head>
<body>
</body>
</html>
</pre>
# Downloading and hosting the files on your own
This options is for those who want to work with angular offline, or want to host the angular files
on their own servers.
If you navigate to <http://code.angularjs.org/>, you'll see a directory listing with all angular
versions since we started releasing versioned build artifacts (quite late in the project lifetime).
Each directory contains all artifacts that we released for a particular version. Once you navigate
to one of these directories you'll see the following list of files:
* `angular-<version>.js` - This file is non-obfuscated, non-minified, and human-readable by opening
it it any editor or browser. In order to get better error messages during development, you should
always use this non-minified angular script.
* `angular-<version>.min.js` - This is a minified and obfuscated version of
`angular-<version>.js` created with Closure compiler. Use this version for production in order to
minimize the size of the application that is downloaded by your user's browser.
* `angular-<version>.tgz` - This is a tarball archive which contains all the other files released
for this angular version. Use this file to get everything in a single download.
* `angular-ie-compat-<version>.js` - This is a special file that contains code and data specifically
tailored for getting Internet Explorer to work with angular. If you host your own copy of angular
files, make sure that this file is available for download and resides under the same parent path as
`angular-<version>.js` or `angular-<version>.min.js`.
* `angular-mocks-<version>.js` - This file contains implementation of mocks that we provide to you
to make testing angular apps even easier. Your unit/integration test harness should load this file
after `angular-<version>.js` is loaded.
* `angular-scenario-<version>.js` - This file is a very nifty JavaScript file, which allows you to
write and execute end to end tests for angular applications.
* `docs-<version>` - this directory contains all the files that compose the
<http://docs.angularjs.org/> documentation app. These files are handy to see the older version of
our docs, or even more importantly, view the docs offline!

View file

@ -1,27 +0,0 @@
@workInProgress
@ngdoc overview
@name Developer Guide: Downloading
@description
# Downloading
To host `angular` on your server, you need RAKE and you need the
`angular` source code. The steps below explain how to download and compile these
required software products:
1. To install RAKE (Ruby Make), download the installation file from
{@link http://rake.rubyforge.org/}.
2. To install the `angular` source code, download the source code from
{@link http://github.com/angular/angular.js}.
3. To compile the source, run the command `rake compile` (the `angular` source
code includes a Rakefile).
The `js` directory contains the following versions of the `angular` bootstrap
code:
* `angular-?.?.?.js` - This file is unobfuscated, uncompressed, and
can be read.
* `angular-?.?.?.min.js` - This is a compressed and obfuscated version of
`angular-?.?.?.js` created with Closure Compiler. Use this version for production and to minimize the size of the application that is downloaded by the user.

View file

@ -1,37 +0,0 @@
@workInProgress
@ngdoc overview
@name Developer Guide
@description
* {@link guide.overview Overview} - An overview of angular, including its philosophy and how it
works.
* {@link guide.bootstrap Bootstrap} - How to bootstrap your application to the angular environment.
* {@link guide.template Template} - How to define your application's view using HTML, CSS, and
other built-in angular constructs.
* {@link guide.compiler Compiler} - All about the HTML compiler that's at the core of angular.
* {@link angular.directive Directive} - How to use XML attributes to augment an existing DOM
element.
* {@link angular.markup Markup} - How to use markup to create shorthand for a widget or a
directive. For example, markup is what allows you to use the double curly brace notation
`{{}}` to bind expressions to elements.
* {@link guide.data-binding Data Binding} - About the mechanism that keeps the model the single
source of truth of your application at all times, with the view as a live projection of the
model.
* {@link angular.filter Filter} - How to format your data for display to the user.
* {@link angular.widget Widget} - How to create new DOM elements that the browser doesn't already
understand.
* {@link angular.validator Validator} - How to validate user input.
* {@link angular.formatter Formatter} - How to format stored data to user-readable text and
parse the text back to the stored form.
* {@link guide.css CSS} - Built-in CSS classes, when angular assigns them, and how to override
their styles.
* {@link angular.scope Scope} - The model in the model-view-controller design pattern. You can
think about scopes as the JavaScript objects that have extra APIs for registering watchers.
* {@link guide.expression Expression} - The bindings that are embedded in an angular View.
* {@link angular.service Service} - Objects that are wired through dependency injection and then
injected into the root scope.
* {@link guide.testing Testing}
* service:$browser(mock)
* {@link guide.downloading Downloading} - How to download, compile, and host the angular
environment on your own server.
* {@link guide.contribute Contributing} - How to contribute to angular project.

View file

@ -1,395 +0,0 @@
Last login: Tue Feb 1 13:42:41 on ttys000
Janet-Daviess-MacBook-Pro:~ janetdavies$ cd angular.js/
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ ./gen_docs.sh
./gen_docs.sh: line 2: /Users/janetdavies/.bashrc: No such file or directory
(node) process.compile should not be used. Use require('vm').runInThisContext instead.
Started
..............................................
Finished in 0.028 seconds
27 tests, 76 assertions, 0 failures
(node) process.compile should not be used. Use require('vm').runInThisContext instead.
Generating Angular Reference Documentation...
DONE. Generated 136 pages in 354ms.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git remote
origin
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git remote -v
origin git@github.com:jedplus/angular.js.git (fetch)
origin git@github.com:jedplus/angular.js.git (push)
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git remote -?
error: unknown switch `?'
usage: git remote [-v | --verbose]
or: git remote add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
or: git remote rename <old> <new>
or: git remote rm <name>
or: git remote set-head <name> (-a | -d | <branch>)
or: git remote [-v | --verbose] show [-n] <name>
or: git remote prune [-n | --dry-run] <name>
or: git remote [-v | --verbose] update [-p | --prune] [(<group> | <remote>)...]
or: git remote set-branches <name> [--add] <branch>...
or: git remote set-url <name> <newurl> [<oldurl>]
or: git remote set-url --add <name> <newurl>
or: git remote set-url --delete <name> <url>
-v, --verbose be verbose; must be placed before a subcommand
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git remote add upstream https://github.com/angular/angular.js.git
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git remote -v
origin git@github.com:jedplus/angular.js.git (fetch)
origin git@github.com:jedplus/angular.js.git (push)
upstream https://github.com/angular/angular.js.git (fetch)
upstream https://github.com/angular/angular.js.git (push)
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch master
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: docs/angular.ngdoc
#
no changes added to commit (use "git add" and/or "git commit -a")
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git diff
diff --git a/docs/angular.ngdoc b/docs/angular.ngdoc
index 3f342d1..00d94da 100644
--- a/docs/angular.ngdoc
+++ b/docs/angular.ngdoc
@@ -2,3 +2,5 @@
@ngdoc overview
@name angular
@namespace The exported angular namespace.
+@description
+Hello Description
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git checkout -b newbie
M docs/angular.ngdoc
Switched to a new branch 'newbie'
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: docs/angular.ngdoc
#
no changes added to commit (use "git add" and/or "git commit -a")
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git add .
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
# modified: docs/angular.ngdoc
#
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ open TextWrangler
The file /Users/janetdavies/angular.js/TextWrangler does not exist.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ open TextWrangler.app
The file /Users/janetdavies/angular.js/TextWrangler.app does not exist.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ open ~/Applications/
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ open /Applications/TextWrangler.app
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ ls
CHANGELOG.md logs
LICENSE nodeserver.sh
README.md perf
Rakefile regression
angularjs.ftp scenario
build server-coverage.sh
css server.sh
docs src
example test
gen_docs.sh test-coverage.sh
images test-perf.sh
java test.sh
jsTestDriver-coverage.conf tmp
jsTestDriver-jquery.conf version.yaml
jsTestDriver-perf.conf watchr-docs.rb
jsTestDriver.conf watchr.rb
lib
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ vi ~/.bash_history
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ vi ~/
Janet-Daviess-MacBook-Pro:angular.js janetdavies$
Janet-Daviess-MacBook-Pro:angular.js janetdavies$
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ vi ~/.gitconfig
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ edit ~/.gitconfig
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
edit: error: -609
error: There was a problem with the editor 'edit'.
Please supply the message using either -m or -F option.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
# modified: docs/angular.ngdoc
#
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ history
1 cd .ssh
2 ls
3 mkdir .ssh
4 chmod 700 .ssh
5 ls
6 ls -al .ssh
7 cd .ssh
8 ssh -keygen
9 ssh-keygen -t rsa -C janet.davies11@gmail.com
10 cat id_rsa.pub
11 cd
12 git clone git@github.com:jedplus/angular.js.git
13 cd angular.js/
14 ./gen_docs.sh
15 rake compile
16 cd angular.js/
17 ./nodeserver.sh
18 cd angular.js/
19 ./gen_docs.sh
20 git remote
21 git remote -v
22 git remote -?
23 git remote add upstream https://github.com/angular/angular.js.git
24 git remote -v
25 git status
26 git diff
27 git checkout -b newbie
28 git status
29 git add .
30 git status
31 git commit
32 open TextWrangler
33 open TextWrangler.app
34 open /Applications/TextWrangler.app
35 ls
36 vi ~/.gitconfig
37 edit ~/.gitconfig
38 git commit
39 git commit
40 git commit
41 git status
42 history
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git log
commit ba6b68b6ae2bb2400a75ca2834fee47bfd60f1c6
Author: Misko Hevery <misko@hevery.com>
Date: Mon Jan 31 16:21:29 2011 -0800
changed the documentation @example to use <doc:example>
commit ed768ebc53ef6746ca83d81892c22d2e9c3afeef
Author: Misko Hevery <misko@hevery.com>
Date: Mon Jan 31 11:55:44 2011 -0800
Developer guide documentation
commit 9fd3dfe49d283c136e29bf60c0da6d4fe2aaed3d
Author: Igor Minar <iiminar@gmail.com>
Date: Tue Feb 1 07:43:09 2011 -0800
add support for $route.reload()
Closes 254
commit d7686a429c43fd031a0d39788973f726d74bdb33
Author: Igor Minar <iiminar@gmail.com>
Date: Mon Jan 31 23:48:04 2011 -0800
add $route.parent for setting parentScope
[1]+ Stopped git log
Janet-Daviess-MacBook-Pro:angular.js janetdavies$
Janet-Daviess-MacBook-Pro:angular.js janetdavies$
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
# modified: docs/angular.ngdoc
#
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git add .
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
# modified: docs/angular.ngdoc
#
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
Aborting commit due to empty commit message.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ edit --?
Usage: edit [-bcehlpuvVw] [+<line number>] ...
+<line number>
-b, --background
--clean
-c, --create
-e, --encoding <encoding>
-h, --help
-l, --launch
-p, --print
--resume
-t, --pipe-title
-u, --create-unix
-v, --version
--view-top
-V, --short-version
-w, --wait
--front-window
--new-window
--separate-windows
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ edit ~/.gitconfig
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git commit
[newbie 3123f8e] my frist message
Committer: Janet Davies <janetdavies@Janet-Daviess-MacBook-Pro.local>
Your name and email address were configured automatically based
on your username and hostname. Please check that they are accurate.
You can suppress this message by setting them explicitly:
git config --global user.name "Your Name"
git config --global user.email you@example.com
If the identity used for this commit is wrong, you can fix it with:
git commit --amend --author='Your Name <you@example.com>'
1 files changed, 2 insertions(+), 0 deletions(-)
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git config --global user.name "Janet Davies""
> git config --global user.email janet.davies11@gmail.com
> git push origin nodeserver.sh
.DS_Store docs/ scenario/
.externalToolBuilders/ example/ server-coverage.sh
.git/ gen_docs.sh server.sh
.gitignore images/ src/
.idea/ java test/
.project jsTestDriver-coverage.conf test-coverage.sh
.settings/ jsTestDriver-jquery.conf test-perf.sh
CHANGELOG.md jsTestDriver-perf.conf test.sh
LICENSE jsTestDriver.conf tmp/
README.md lib/ version.yaml
Rakefile logs/ watchr-docs.rb
angularjs.ftp nodeserver.sh watchr.rb
build/ perf/
css/ regression/
> git status
>
>
>
> ls
>
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git config --global user.name "Janet Davies"Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git config --global user.email janet.davies11@gmail.com
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch newbie
nothing to commit (working directory clean)
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git push origin newbie
Counting objects: 7, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (4/4), done.
Writing objects: 100% (4/4), 392 bytes, done.
Total 4 (delta 3), reused 0 (delta 0)
To git@github.com:jedplus/angular.js.git
* [new branch] newbie -> newbie
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git push origin newbie
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ history
1 cd .ssh
2 ls
3 mkdir .ssh
4 chmod 700 .ssh
5 ls
6 ls -al .ssh
7 cd .ssh
8 ssh -keygen
9 ssh-keygen -t rsa -C janet.davies11@gmail.com
10 cat id_rsa.pub
11 cd
12 git clone git@github.com:jedplus/angular.js.git
13 cd angular.js/
14 ./gen_docs.sh
15 rake compile
16 cd angular.js/
17 ./nodeserver.sh
18 cd angular.js/
19 ./gen_docs.sh
20 git remote
21 git remote -v
22 git remote -?
23 git remote add upstream https://github.com/angular/angular.js.git
24 git remote -v
25 git status
26 git diff
27 git checkout -b newbie
28 git status
29 git add .
30 git status
31 git commit
32 open TextWrangler
33 open TextWrangler.app
34 open /Applications/TextWrangler.app
35 ls
36 vi ~/.gitconfig
37 edit ~/.gitconfig
38 git commit
39 git commit
40 git commit
41 git status
42 history
43 git log
44 git status
45 git add .
46 git status
47 git commit
48 git commit
49 git commit
50 git commit
51 git commit
52 git commit
53 edit --?
54 edit ~/.gitconfig
55 git commit
56 git config --global user.name "Janet Davies""
git config --global user.email janet.davies11@gmail.com
git status
ls
57 git config --global user.name "Janet Davies"
58 git config --global user.email janet.davies11@gmail.com
59 git status
60 git push origin newbie
61 history
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git checkout master
Switched to branch 'master'
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git status
# On branch master
nothing to commit (working directory clean)
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git pull upstream master
From https://github.com/angular/angular.js
* branch master -> FETCH_HEAD
Already up-to-date.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git pull upstream
From https://github.com/angular/angular.js
* [new branch] gh-pages -> upstream/gh-pages
* [new branch] master -> upstream/master
You asked to pull from the remote 'upstream', but did not specify
a branch. Because this is not the default configured remote
for your current branch, you must specify a branch on the command line.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git pull upstream master
From https://github.com/angular/angular.js
* branch master -> FETCH_HEAD
Already up-to-date.
Janet-Daviess-MacBook-Pro:angular.js janetdavies$ git checkout master