From 1c2d14a8b8f5e9fa1a95baa0fe1c85b9c084456a Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 17 Nov 2016 16:53:28 -0800 Subject: [PATCH] docs(guide & api): feedback/issue links for Dart should refer to Dart repos (#2821) * docs(guide/index): feedback link to Dart repo for Dart - Also added links to chapters mentioned in table. - Other minor copyedits. * docs(api): issue links should refer to Dart repo * post-review updates * add link to Advance and Guide chapters * ensure that we can determine which language is active --- public/_includes/_util-fns.jade | 2 + public/docs/dart/latest/_util-fns.jade | 3 ++ public/docs/dart/latest/api/index.jade | 15 ++++--- public/docs/dart/latest/guide/index.jade | 9 ---- public/docs/ts/latest/guide/index.jade | 53 ++++++++++++------------ 5 files changed, 40 insertions(+), 42 deletions(-) diff --git a/public/_includes/_util-fns.jade b/public/_includes/_util-fns.jade index 19b17fe945..716858c295 100644 --- a/public/_includes/_util-fns.jade +++ b/public/_includes/_util-fns.jade @@ -37,6 +37,8 @@ //- Location of sample code - var _liveLink = 'live link'; +- var _ngRepoURL = 'https://github.com/angular/angular'; +- var _ngDocRepoURL = 'https://github.com/angular/angular.io'; //- NgModule related - var _AppModuleVsAppComp = 'AppModule' diff --git a/public/docs/dart/latest/_util-fns.jade b/public/docs/dart/latest/_util-fns.jade index 76cd1fabf4..d388b4c8ec 100644 --- a/public/docs/dart/latest/_util-fns.jade +++ b/public/docs/dart/latest/_util-fns.jade @@ -19,6 +19,9 @@ include ../../../_includes/_util-fns - var _appDir = 'lib'; - var _indexHtmlDir = 'web'; - var _mainDir = 'web'; +- var _ngRepoURL = 'https://github.com/dart-lang/angular2'; +//- Don't override this value quite yet: +//- var _ngDocRepoURL = 'https://github.com/dart-lang/site-webdev'; //- NgModule related - var _AppModuleVsAppComp = 'AppComponent' diff --git a/public/docs/dart/latest/api/index.jade b/public/docs/dart/latest/api/index.jade index 477cf84fb3..cdf4db0b3b 100644 --- a/public/docs/dart/latest/api/index.jade +++ b/public/docs/dart/latest/api/index.jade @@ -1,9 +1,12 @@ -:marked - > **Known issues:** The angular.io issue tracker contains [all known - issues][api-issues]; if you notice others, please [report - them][new-issue]. Thanks! +include ../_util-fns - [new-issue]: https://github.com/angular/angular.io/issues/new?labels=dart,api&title=%5BDart%5D%5BAPI%5D%20 - [api-issues]: https://github.com/angular/angular.io/issues?q=label%3Aapi+label%3Adart +:marked + > **Known issues:** The Angular issue tracker contains + [all known issues][api-issues]; if you notice others, please + [report them][new-issue]. Thanks! + + [new-issue]: !{_ngRepoURL}/issues/new?title=%5BAPI%20docs%5D + [api-issues]: !{_ngRepoURL}/issues +//- ?q=label%3Aapi api-list(src="api-list.json" lang="dart") diff --git a/public/docs/dart/latest/guide/index.jade b/public/docs/dart/latest/guide/index.jade index 417bf9ea8d..d3289f4c55 100644 --- a/public/docs/dart/latest/guide/index.jade +++ b/public/docs/dart/latest/guide/index.jade @@ -2,12 +2,3 @@ extends ../../../ts/latest/guide/index.jade block includes include ../_util-fns - -block example-links - :marked - Look for a link to that sample near the top of each page. - For example, the sample repo https://github.com/angular-examples/architecture - contains the code - for the [Architecture](architecture.html) chapter's sample. - A running version of that sample is at - https://angular-examples.github.io/architecture/. diff --git a/public/docs/ts/latest/guide/index.jade b/public/docs/ts/latest/guide/index.jade index d63d826dce..96a7bcf9e3 100644 --- a/public/docs/ts/latest/guide/index.jade +++ b/public/docs/ts/latest/guide/index.jade @@ -9,7 +9,6 @@ figure are building client applications in HTML and #{_Lang}.
-:marked ## Organization The documentation is divided into major thematic sections, each @@ -17,43 +16,52 @@ figure block js-alert +- var __lang = _docsFor || current.path[1] || 'ts'; +- var guideData = public.docs[__lang].latest.guide._data; +- var advancedLandingPage = ''; +- for(var page in guideData) { +- if (!guideData[page].basics && !guideData[page].hide) { advancedLandingPage = page; break; } +- } +- var advancedUrl = './' + advancedLandingPage + '.html' - var top="vertical-align:top" table(width="100%") col(width="15%") col tr(style=top) - td QuickStart + td QuickStart td :marked The foundation for every page and sample in this documentation. tr(style=top) - td Guide + td Guide td :marked The essential ingredients of Angular development. tr(style=top) - td API Reference + td API Reference td :marked Authoritative details about each member of the Angular libraries. tr(style=top) - td Tutorial + td Tutorial td :marked A step-by-step, immersive approach to learning Angular that introduces the major features of Angular in an application context. tr(style=top) - td Advanced + td Advanced td :marked In-depth analysis of Angular features and development practices. tr(style=top) - td Cookbook + td Cookbook td :marked Recipes for specific application challenges, mostly code snippets with a minimum of exposition. + :marked ## Learning path + You don't have to read the guide straight through. Most pages stand on their own. For those new to Angular, the recommended learning path runs through the *Guide* section: @@ -80,37 +88,28 @@ table(width="100%") After reading the above sections, you can skip to any other pages on this site. -:marked ## Code samples Each page includes code snippets that you can reuse in your applications. These snippets are excerpts from a sample application that accompanies the page. -block example-links - :marked - Look for a link to a running version of that sample near the top of each page, - such as this from the [Architecture](architecture.html) page. + Look for a link to a running version of that sample near the top of each page, + such as this from the [Architecture](architecture.html) page. +

+ The link launches a browser-based code editor where you can inspect, modify, save, and download the code. +

- The link launches a browser-based code editor where you can inspect, modify, save, and download the code. - -:marked A few early pages are written as tutorials and are clearly marked as such. The rest of the pages highlight key points in code rather than explain each step necessary to build the sample. You can always get the full source through the #{_liveLink}. ## Reference pages - The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios. + - The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios. + - The [Glossary](glossary.html) defines terms that Angular developers should know. + - The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries. - The [Glossary](glossary.html) defines terms that Angular developers should know. + ## We welcome feedback! - The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries. - - ## Feedback - - We welcome feedback! - - Use the [angular.io Github repo](https://github.com/angular/angular.io) for **documentation** issues and pull requests. - - - Use the [Angular Github repo](https://github.com/angular/angular) to report issues with **Angular** itself. + - Use the [website GitHub repo](!{_ngDocRepoURL}) for **documentation** issues and pull requests. + - Use the [Angular GitHub repo](!{_ngRepoURL}) to report issues with **Angular** itself.