Commit Graph

171 Commits

Author SHA1 Message Date
Patrice Chalin 907f848c95 docs(toh-6): refactoring of 'add, edit, delete heroes' (#2170)
* docs(toh-6/dart): refactoring of 'add, edit, delete heroes'

Refactoring of "add, edit, delete heroes" section of toh-6 from one big
bottom-up step into small independent feature slices, where the user
achieves a "milesone" (i.e., can run the full app) after each feature
section. The section rewrite is shorter and offers a better UX.

Other simplifications:
- Error handling is consistent: in the hero service we log to the
console, everwhere else we just let errors bubble up.
- Hero service methods renamed based on function (create, update)
rather then lower-level implementation (post, put).
- @Output properties have been eliminated (since they weren't
explained).

E2E tests now pass on both the TS and Dart sides.

* docs(toh-6/ts): refactoring of 'add, edit, delete heroes'

Refactoring of "add, edit, delete heroes" section of toh-6 from one big
bottom-up step into small independent feature slices, where the user
achieves a "milesone" (i.e., can run the full app) after each feature
section. The section rewrite is shorter and offers a better UX.

Other simplifications:
- Error handling is consistent: in the hero service we log to the
console, everwhere else we just let errors bubble up.
- Hero service methods renamed based on function (create, update)
rather then lower-level implementation (post, put).
- @Output properties have been eliminated (since they weren't
explained).

E2E tests now pass on both the TS and Dart sides.

Post-Dart-review updates included.

* docs(toh-6): ward tweaks
2016-08-26 14:57:45 -07:00
Brandon Roberts 5c5c9ca16c fix(toh-5): Fixed issues in tutorial flow
The HeroDetailComponent should be in the module declarations from the beginning.
InMemoryWebApiModule.forRoot(InMemoryDataService) and correct text
2016-08-19 03:43:00 -07:00
Brandon Roberts a35fcb4dfd chore(router): Added ModuleWithProviders to routing exports
closes #2113
2016-08-18 23:57:54 -07:00
Jesús Rodríguez e9a41bac47 docs(toh): add return types
closes #1983
2016-08-17 22:41:06 -07:00
Jesús Rodríguez a2d6ea3a97 docs(toh): consistency fix
closes #2087
2016-08-17 17:47:15 -07:00
Patrice Chalin 44862b95f8 docs(toh-3): fix for empty tab (#2122)
Fixes #2119.
2016-08-17 13:33:11 -07:00
Patrice Chalin 0c0c6f69f3 docs(toh-5): TS/Dart review, and Dart resync (#2115)
* docs(toh-5): review and update/resync Dart

**NOTE: run `gulp add-example-boilerplate` after pulling in the
commit.**

This is preparatory work for #2035.
As part of the the chapter review, the Dart .jade was enhanced to use
Jade extends (#2018).
By the same token it contributed to a post-RC5 resync (#2077). Other
key changes:

Dart and TS code:
- Eliminated `styles.1.css` in favor of docregions in `styles.css`.
- `docregion` tags renamed in a few places.
- **No other code changes**.

TS prose
- Fixed: misnamed variable `routing` -> `appRoutes`.
- All other changes are **minor copy edits**, or changes to support
Dart via Jade extends.

Diff of generated HTML for TS chapter was inspected to ensure only
minor copy edits prevailed (i.e., that the support for Jade extends had
no impact on the generated HTML).

* docs(toh-5): edits after doing tutorial

- Some adjustments following actually doing the tutorial. In some cases code shown (e.g. this is what file foo should look like now) didn't match what the user would have. E.g., lingering @Input on the hero property.
- Fixed some lingering deprecated-router prose elements on TS side (e.g., still referring to a route by the old string names like `HeroDetail`).
- Added extra step to `app.component.ts` creation rather than having a critical-call-out later on.
- Reorder some prose for better harmony between TS and Dart prose (also improves the flow).
- Moved the `styleUrls` call-out to the point of first use.

* post-review changes

* more post-review changes

* toh-6 cache update
2016-08-17 13:31:40 -07:00
Patrice Chalin 9869bf585d docs(toh-6): systemjs.config.json -> systemjs.config.js (#2116)
Copyedit in file tree.
2016-08-17 11:11:50 -07:00
Patrice Chalin dfd46af604 docs(toh-6): post-RC5 Dart resync and TS fixes (#2095)
* toh-6: trim spaces from cache file to simplify diff

* toh-6: copy latest over cache before editing latest

* docs(toh-6): post-RC5 Dart resync and TS fixes

Contributes to #2077.

TS-side changes include:
- Merged three versions of `app/app.module{,1,2}.ts` into a single file
and used docregions instead.
- Misnamed files:
  - `rxjs-operators.ts` -> `rxjs-extensions.ts`
  - `hero-search.service.html` -> `hero-search.component.html`
- Fixed BAD FILENAME error.

Lint reports no errors and toh-6 e2e tests pass.
2016-08-12 11:21:16 -07:00
Peter Bacon Darwin d79adb2422 docs(rc5): update docs and plunkers for rc5 2016-08-09 11:48:07 -07:00
Adam d26afa90fd docs(toh-6): Move styles from sample.css to heroes.component.css
closes #1751
Move additional styles from `sample.css` to `hero-search.component.css`.
Edit tutorial to reflect the removal of `sample.css` and the change to `heroes.component.css`.
Edit tutorial to reflect the addition of `hero-search.component.css` file.
Edit `hero-search.component.ts` to include styles from `hero-search.component.css`.
Remove reference to `/public/docs/_examples/toh-6/ts/sample.css` from `/public/docs/_examples/toh-6/ts/index.html`.
2016-08-05 16:45:53 -07:00
Patrice Chalin 8a6c5b5725 docs(toh-6): add hero search to Dart; minor edits to TS (#2018)
* docs(toh-6/dart): add hero search

Fixes #1924.

* docs(toh-6/ts): minor updates

* post-review updates

* post-review updates
2016-08-02 09:59:35 -07:00
Patrice Chalin 04d5337b75 docs(toh-6): search query fixes
closes #2008
Changes:
- Drop `asObservable()` since it is deprecated in RxJS 5 (see the
[migration
guide](https://github.com/ReactiveX/RxJS/blob/master/MIGRATION.md#operat
ors-renamed-or-removed)).
- Drop `+` from hero search query URL: `app/heroes/?name=${term}+`. At
best it is interpreted as a regex op that serves no purpose, at worst,
it gets interpreted as a space (cf. [HTML 4.01 section
17.13.4](https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13.4)
).
- Rename `searchSubject` to `searchTerms`
- Other minor tweaks to prose.

This work is in preparation for #1924.

Note: toh-6 tests pass.
2016-08-01 11:50:53 -07:00
Jesús Rodríguez 4507589e26 docs(toh): add explanation for using the search box
closes #2002
2016-07-29 12:44:20 -07:00
Torgeir Helgevold f00b96fab8 docs(toh-6): remove details about throw 2016-07-19 22:48:55 -04:00
Patrice Chalin b4c92d9c9c docs(toh-6/dart): quickfix to "BAD FILENAME" errors (#1929)
Exclude the new Observables section entirely for now.
2016-07-19 15:30:42 -07:00
Ward Bell ce2e14e4ae docs(toh-pt6): bind to a component method rather than a RxJS Subject
updated text accordingly
2016-07-19 12:26:14 -07:00
Torgeir Helgevold f50dff818a docs(toh-pt6): add observables to HTTP tutorial chapter
closes #1528
2016-07-18 23:12:44 -07:00
Benoit Lateltin 5bac678c60 docs(toh-pt5): fix typo in tutorial
closes #1913
2016-07-18 11:10:19 -07:00
Brandon Roberts 5104470558 docs(router): Removed refs to deprecated router; lowerCamelCase constants
closes #1834
2016-07-11 21:44:12 -07:00
Patrice Chalin b0e0d94b5c docs: revert Jade to markdown
closes #1818
Previously, the markdown of some chapters was converted to Jade markup
to support the conditional exclusion of TS prose parts in Dart
chapters. This commit reverts some of that back to clean markdown,
thanks to a few custom directives.
2016-07-05 23:03:30 -07:00
Brandon Roberts 97fbda0d76 docs(toh-6/ts): Upgraded http tutorial to use new router 2016-06-28 13:03:04 -07:00
Brandon Roberts f3189546a6 docs(toh-5): Upgraded tutorial to new router 2016-06-28 12:52:47 -07:00
Patrice Chalin 3fe0fb077c docs(toh-6/ts): minor edits and enhancements (#1686)
* docs(toh-6/ts): minor edits and enhancements

Changes to prose:

- Complete TODO item of displaying `heroes.component` errors.
- Mainly copyedits.
- Add of blocks statements so that prose can be used on Dart side.
- Show excerpt and briefly explain of changes (previously missing):
  - `app/hero-detail.component.html`
  - `app/heroes.component.ts` error handling
- Add missing file to changed/added files listing and makeTabs
  - `toh-6/ts/app/in-memory-data.service.ts,
  - `toh-6/ts/sample.css`

Code changes:

- Mainly copyedits
- Renamed `heroes.component.ts` `delete` to `deleteHero` to match
naming of other methods

* remove unnecessary change relative to toh-5
2016-06-27 11:23:27 -07:00
Patrice Chalin 6e5d8e6491 docs(toh-5/dart): review edits and code cleanup (#1643) 2016-06-15 07:46:26 -07:00
Patrice Chalin ca2e5c5d1d docs(toh-4/ts): copyedits
closes #1638
2016-06-13 11:40:30 -07:00
Helmi 7f256eea75 Fix typo in 'Simulating the web api' section.
closes #1655
2016-06-13 11:05:15 -07:00
Foxandxss 61ad427319 docs(toh): add missing snippets
closes #1649
2016-06-13 10:46:53 -07:00
Patrice Chalin fd46bf4970 docs(toh-5/ts): minor edits
closes #1644
2016-06-13 10:45:23 -07:00
Patrice Chalin 070cb5a193 docs(toh-3/ts): copyedits
closes #1630
2016-06-13 10:36:04 -07:00
Patrice Chalin 16848fc822 docs(toh-2/ts): copyedits
closes #1622
2016-06-13 10:34:19 -07:00
Patrice Chalin 2fc7e5ab50 docs(toh-1/ts): minor edits
closes #1615
- Fixed HTML.
- Removed unnecessary snippet since it is in the code.
- Copyedit: (Hero property) -> (hero property).
2016-06-13 10:28:04 -07:00
Patrice Chalin 7e52648ee7 docs(toh): update live example links (#1602) 2016-06-07 15:51:25 -07:00
jevonearth f7cf6fde9f docs(toh-6): Fix typo in 'Add/Delete in the HeroesComponent' section.
closes #1603
2016-06-06 17:28:07 -07:00
twinssbc 6f02f76fc2 docs: remove duplicated words in toh-pt6.jade
closes #1575
2016-06-04 01:25:41 -07:00
Anastasia Kozaeva 2f3cb405e8 Fix typo in 'Error Handling' section
closes #1592
Remove duplicate 'to'
2016-06-04 01:24:00 -07:00
Anderson 301aadddde docs(toh-pt6): fix filename typo 2016-06-01 01:19:37 -07:00
Vikash 8569479423 docs: fix numerous typos in many doc files.
closes #1509
2016-06-01 01:08:56 -07:00
Ward Bell 2f115a3425 chore: fix broken devguide links as of May 31
Did not fix broken Dart and API links
2016-06-01 00:52:22 -07:00
Christopher Thorne 2d27097d55 docs(toh-pt6): correct DetailHeroComponent to HeroDetailComponent
closes #1550
2016-05-31 22:32:55 -07:00
Christopher Thorne 3d868da4b7 docs(toh-pt5): change getHero to match toh-pt6 getHero
closes #1551
2016-05-31 22:31:04 -07:00
Foxandxss 2bc166c34f docs(toh): fix some header extensions
closes #1549
2016-05-29 14:36:10 -07:00
Foxandxss 508b779a41 docs(toh): add instructions to add the goBack method
closes #1478
2016-05-23 12:18:46 -07:00
Foxandxss 129b34c77e docs(toh): update HTTP chapter with style guide conventions
closes #1477
2016-05-23 12:15:10 -07:00
Foxandxss 33b5829b25 docs(toh): put a bit of clarification
closes #1352
2016-05-20 23:40:55 -07:00
Ward Bell f9fea00824 docs(component-relative-paths): new cookbook 2016-05-20 20:33:38 -07:00
Ward Bell 3324bd944d docs(toh-6): fix broken 'Add Hero' and fill in instructional gaps 2016-05-19 19:00:20 -07:00
Ward Bell a4bc455030 docs(toh): remove unneeded directive from heroes.component 2016-05-19 00:57:35 -07:00
Ward Bell e91659ac13 docs(tutorial/ts): delete tutorial sample in favor of toh-6 2016-05-19 00:30:30 -07:00
Torgeir Helgevold e4db340464 docs:(TOH chapter on Http) New Tour of Hero Chapter on Http 2016-05-18 23:38:08 -07:00
Dmitri Suvorov 33745ec220 docs(tutorial): fix typo (slowy -> slowly)
closes #1332
2016-05-11 19:24:00 -07:00
Foxandxss c8bdbd5ea9 docs(toh): link to deprecated router
closes #1309
2016-05-10 21:56:19 -07:00
Foxandxss 596825a8b1 docs: update all docs to partially comply the style-guide 2016-05-03 12:42:44 -06:00
Ward Bell 3d5302adce chore: update to rc.0 2016-05-02 19:57:28 -07:00
Filipe Silva ebc022e475 docs: update prose for the `let` change to ngFor 2016-04-28 18:37:45 -07:00
Naomi Black 6d13db472a chore(links): make links to API docs relative 2016-04-19 17:44:38 -07:00
Alberto Jiménez López 8e7c552452 docs: Remove double 'the' & missing dashes in several files
closes #1073
2016-04-11 21:53:28 -07:00
Kathy Walrath b3d5f2bb65 fix: build breaker (#1064) 2016-04-07 21:41:15 -07:00
Kathy Walrath a678d572ce docs(dart/toh): add intro & toh-1 pages (#1063) 2016-04-07 21:11:13 -07:00
James Laverack 56ed5e345c docs(toh-4): reword the getHeroesSlowly instructions
closes #1011
rewording to: "replace `_heroService.getHeroes` with `_heroService.getHeroesSlowly`"
2016-04-02 15:30:16 -07:00
Foxandxss 5f73911eaf chore(toh): change inputs array for input decorator/hero now a class 2016-03-25 16:51:46 -07:00
Emma e17821492e docs: update link to learning promises
to the chapter in Dr. Axel Rauschmayer's ES6 book from his old post
closes #1005

The old link on the documentation lead to an article on promises that
contained outdated information, so this one leads to newer content.
2016-03-25 15:09:09 -07:00
Ward Bell a2cb80330a docs: update to beta-12 2016-03-23 21:39:13 -07:00
Foxandxss b2f2fb87ec docs(toh): make a few corrections
closes #967
2016-03-17 21:09:54 -07:00
Foxandxss cb0af7860d docs(toh4): fix anchor
closes #975
2016-03-16 15:53:24 -07:00
Filipe Silva b5ea1d8f68 docs(lifecycle-hooks): add hook sections, revise sample, add DoCheck & tests 2016-03-16 01:52:11 -07:00
Foxandxss 6ca1ac2c45 docs: instrucs for "download-and-go" development with quickstart source repo 2016-03-14 12:44:25 -07:00
Foxandxss b300d7b116 docs: add quickstart repository where needed 2016-03-14 09:11:50 -07:00
Ward Bell 52ece7834a docs(toh-pt1): revision suggested in #412
closes #941
2016-03-08 21:01:32 -08:00
Ward Bell beb8efc71f docs(toh-5) reworded templateUrl/styleUrls notes 2016-03-08 15:09:31 -08:00
Foxandxss af1eaae873 docs(toh5): add better explanations for templateUrl
closes #929
2016-03-08 15:07:00 -08:00
Deborah Kurata 818faff117 doc(tutorial): Fixed typo.
closes #926
2016-03-08 14:48:04 -08:00
Foxandxss d6dc97722b docs(toh5): fix typo
closes #930
2016-03-08 14:46:31 -08:00
Ward Bell bf3ed182a7 docs: left nav is driven by _data.json files 2016-03-04 19:54:27 -08:00
Ward Bell ed5effa503 docs: only allow 'Next Step' for *nextable* chapters 2016-03-03 17:59:36 -08:00
Josh Otis 746a6649b2 chore: new flat left navigation panel (all language tracks) 2016-03-03 04:51:52 -08:00
Ward Bell 12500ebc29 docs(router): fix plunker preview image; move plunker link to top 2016-02-28 13:55:37 -08:00
Ward Bell ad7f172ea5 docs: share 'styles.css' across all samples all langs; fix styles 2016-02-28 12:47:01 -08:00
Ondra Hlaváč 8496dd016f docs(toh-5): fixes a typo in a link
closes #857
2016-02-19 00:29:24 -08:00
Arıl Bozoluk bdc3e44dcb Added next tutorial chapter(toh-pt5) link
closes #844

toh-pt4.html was missing next tutorial chapter link and tutorial flow was getting interrupted by this.

I've added next tutorial chapter link(toh-pt5) with corresponding text.
2016-02-16 08:24:25 -08:00
Ward Bell 3d992384c3 chore(devguide/ts): to beta.6 + typings + related doc updates 2016-02-12 00:56:22 -08:00
John Papa 1365d82527 docs(tutorial): add part 5-routing 2016-02-08 11:01:29 -08:00
Ward Bell b0ebc3897c docs(devguide/forms): add "new hero" with form reset workaround and msg hiding
closes #792
2016-02-01 14:13:51 -08:00
Ward Bell 9e75006b2d chore(devguide): remove or guard unpublished files
closes #779
2016-01-29 13:48:51 -08:00
Ward Bell 79d3d9f0ad docs(samples): convert boot.ts -> main.ts
plus router text fix and missed beta.2 update to QS.js
closes #773
2016-01-28 17:32:38 -08:00
Frank van Wijk fe5c605090 docs(tutorial): typo: succint -> succinct.
closes #711
2016-01-18 01:10:34 -08:00
Ward Bell 2b2ec380b7 docs(tutorial): update description of app behavior
closes #716. See also #685
2016-01-17 22:51:49 -08:00
Steven Lacks 14900ea97c docs(tutorial): toh-4 (Services) typo
closes #647
missing period in 'hero-detailcomponent.ts'
2016-01-04 23:36:46 -08:00
John Papa f4c69b6ad0 docs(tutorial): update css and related fixes
closes #603
2015-12-23 09:36:16 -08:00
Ward Bell 5bec58577f docs(Tutorial): minor repairs to toh-4
close #602
John's comments
Fix for https://github.com/johnpapa/angular2-tour-of-heroes/issues/41
2015-12-23 09:05:59 -08:00
adamclerk c2e1b55f6c Fixing typo in pt4 of tutorial
closes #596
I think the author intended to reference `providers` and not `directives`.
He did indeed!
2015-12-21 10:08:54 -08:00
John Papa 7e86e9411b docs(tutorial): add ToH part 4
closes #589
2015-12-19 14:27:59 -08:00
Deborah Kurata 632d0d8d93 docs(dependency injection): update imports for beta.0
closes #584
2015-12-19 14:25:39 -08:00
Ward Bell f4acc0ccbc docs(tutorial): Part 3 improvements + input explanation
Updated Attribute Directives chapter with appendix on input properties
closes #576
2015-12-17 02:12:58 -08:00
Ward Bell 82383bc673 docs(tutorial): part 3 + revisions to intro, 1 & 2
closes #573
2015-12-16 18:08:38 -08:00
Ward Bell 4fda2c7854 docs(*): `npm run go` -> `npm start` (TS only)
closes #559
Convert npm script command from npm run go to npm start ...
because that's the way it should have been for TypeScript files.
2015-12-16 08:18:44 -08:00
Robert Messerle 068771228a removes first demo
changes text from `how we roll` to `up next`
changes font size for code blocks from `15px` to `13px`
changes links from `edit on plunker` to `try in plunker`
re-orders tabs in code samples
2015-12-14 22:57:53 -08:00
John Papa ab5390a51e docs(tutorial): combines all 4 sections + revisions/updates to a.53, hides 3&4
closes #488

ToH History (oldest-to-latest):
----------------------------
created code example/snippets files for use with +makeExample, replace usage of  "pre.prettyprint.lang-bash" with this:  code-example(format="." language="bash").
fixed spelling errors in examples file path used by +makeExample
changed usage of "code-example" to "+makeExample"
adding code example/snippets files used in toh 1
fixed example file paths, replaced "pre.prettyprint.lang-bash" with "code-example. "
(docs) toh-pt3 initial state
created code examples for display in jade, starting conversion of Google doc and trying +makeExample rendering
all text copied from doc to jade, still some styling and formatting to perform
completed conversion and styling, moved toh3 example files to "tutorial" folder under _examples
created specific code example files for chapter toh 3 and re-pathed references in +makeExample
minor edit
docs) toh combined - initial combined commit
updated ToH for a.52
tons of changes, including de-kebab-ing, removed src folder, updated tsconfig too
fixing snippets using incorrect ending input tag
using inline html and css for the app.component.
ToH Part 1 Code: updated the imports, removed obsolete directive delcarations
ToH Code Part 1: updated to use imports, interface. will hit others soon
toh part 1: ngModel fix
toh part1: removed obsolete story that referred to how we used to have to import and declare all directives we used. yay!
ToH Part 1: updated to use `boot.ts` and `app.component.ts`. this affected the partials, snippets, and the story.
toh part 1: using `npm run go`
toh parts 1 -4: modified all places to use `npm run go`
toh part 1: refactor for jade
toh part 1: fixing the code samples
toh part 2: seeping through the story
toh part 2: fixing snippets.
toh part 2: replaced ngClass with class.selected
toh part 2: removed whitespace
toh part 2: added final state to the code
toh: fixing paths
toh part 4: fixing src/app path to app
toh part 3: fixing folder path
toh part 2: fixed typo
toh part 2: typo on ngModel
toh part 2: added ngif
toh part 2: removed old hero property. moved the details lower, where we need it
toh index: updated hero list image to show consistent styling as the other images here
QS spelling error (targes -> targets)
tweeks: space and ngIF
2015-12-14 19:57:55 -08:00
johnapost 2843cf2d5d docs: fix dead links in toh-p1; closes #393 2015-11-23 16:39:42 -08:00
Arliang 8a4861c26a (docs): toh - fix typo; closes #385 2015-11-23 16:24:04 -08:00