Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 1c2d14a

Browse files
chalinkwalrath
authored andcommitted
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
1 parent e59cd9a commit 1c2d14a

File tree

5 files changed

+39
-41
lines changed

5 files changed

+39
-41
lines changed

public/_includes/_util-fns.jade

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737

3838
//- Location of sample code
3939
- var _liveLink = 'live link';
40+
- var _ngRepoURL = 'https://github.com/angular/angular';
41+
- var _ngDocRepoURL = 'https://github.com/angular/angular.io';
4042

4143
//- NgModule related
4244
- var _AppModuleVsAppComp = 'AppModule'

public/docs/dart/latest/_util-fns.jade

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ include ../../../_includes/_util-fns
1919
- var _appDir = 'lib';
2020
- var _indexHtmlDir = 'web';
2121
- var _mainDir = 'web';
22+
- var _ngRepoURL = 'https://github.com/dart-lang/angular2';
23+
//- Don't override this value quite yet:
24+
//- var _ngDocRepoURL = 'https://github.com/dart-lang/site-webdev';
2225
2326
//- NgModule related
2427
- var _AppModuleVsAppComp = 'AppComponent'
+8-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
include ../_util-fns
2+
13
:marked
2-
> **Known issues:** The angular.io issue tracker contains [all known
3-
issues][api-issues]; if you notice others, please [report
4-
them][new-issue]. Thanks!
4+
> **Known issues:** The Angular issue tracker contains
5+
[all known issues][api-issues]; if you notice others, please
6+
[report them][new-issue]. Thanks!
57

6-
[new-issue]: https://github.com/angular/angular.io/issues/new?labels=dart,api&title=%5BDart%5D%5BAPI%5D%20
7-
[api-issues]: https://github.com/angular/angular.io/issues?q=label%3Aapi+label%3Adart
8+
[new-issue]: !{_ngRepoURL}/issues/new?title=%5BAPI%20docs%5D
9+
[api-issues]: !{_ngRepoURL}/issues
10+
//- ?q=label%3Aapi
811
912
api-list(src="api-list.json" lang="dart")

public/docs/dart/latest/guide/index.jade

-9
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,3 @@ extends ../../../ts/latest/guide/index.jade
22

33
block includes
44
include ../_util-fns
5-
6-
block example-links
7-
:marked
8-
Look for a link to that sample near the top of each page.
9-
For example, the sample repo https://github.com/angular-examples/architecture
10-
contains the code
11-
for the [Architecture](architecture.html) chapter's sample.
12-
A running version of that sample is at
13-
https://angular-examples.github.io/architecture/.

public/docs/ts/latest/guide/index.jade

+26-27
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,59 @@ figure
99
are building client applications in HTML and #{_Lang}.
1010
<br class="l-clear-left">
1111

12-
:marked
1312
## Organization
1413

1514
The documentation is divided into major thematic sections, each
1615
a collection of pages devoted to that theme.
1716

1817
block js-alert
1918

19+
- var __lang = _docsFor || current.path[1] || 'ts';
20+
- var guideData = public.docs[__lang].latest.guide._data;
21+
- var advancedLandingPage = '';
22+
- for(var page in guideData) {
23+
- if (!guideData[page].basics && !guideData[page].hide) { advancedLandingPage = page; break; }
24+
- }
25+
- var advancedUrl = './' + advancedLandingPage + '.html'
2026
- var top="vertical-align:top"
2127
table(width="100%")
2228
col(width="15%")
2329
col
2430
tr(style=top)
25-
td <b>QuickStart</b>
31+
td <b><a href="../quickstart">QuickStart</a></b>
2632
td
2733
:marked
2834
The foundation for every page and sample in this documentation.
2935
tr(style=top)
30-
td <b>Guide</b>
36+
td <b><a href="./">Guide</a></b>
3137
td
3238
:marked
3339
The essential ingredients of Angular development.
3440
tr(style=top)
35-
td <b>API Reference</b>
41+
td <b><a href="../api">API Reference</a></b>
3642
td
3743
:marked
3844
Authoritative details about each member of the Angular libraries.
3945
tr(style=top)
40-
td <b>Tutorial</b>
46+
td <b><a href="../tutorial">Tutorial</a></b>
4147
td
4248
:marked
4349
A step-by-step, immersive approach to learning Angular that
4450
introduces the major features of Angular in an application context.
4551
tr(style=top)
46-
td <b>Advanced</b>
52+
td <b><a href="!{advancedUrl}">Advanced</a></b>
4753
td
4854
:marked
4955
In-depth analysis of Angular features and development practices.
5056
tr(style=top)
51-
td <b>Cookbook</b>
57+
td <b><a href="../cookbook">Cookbook</a></b>
5258
td
5359
:marked
5460
Recipes for specific application challenges, mostly code snippets with a minimum of exposition.
61+
5562
:marked
5663
## Learning path
64+
5765
You don't have to read the guide straight through. Most pages stand on their own.
5866

5967
For those new to Angular, the recommended learning path runs through the *Guide* section:
@@ -80,37 +88,28 @@ table(width="100%")
8088

8189
After reading the above sections, you can skip to any other pages on this site.
8290

83-
:marked
8491
## Code samples
8592

8693
Each page includes code snippets that you can reuse in your applications.
8794
These snippets are excerpts from a sample application that accompanies the page.
8895

89-
block example-links
90-
:marked
91-
Look for a link to a running version of that sample near the top of each page,
92-
such as this <live-example name="architecture"></live-example> from the [Architecture](architecture.html) page.
96+
Look for a link to a running version of that sample near the top of each page,
97+
such as this <live-example name="architecture"></live-example> from the [Architecture](architecture.html) page.
98+
<p if-docs="ts">
99+
The link launches a browser-based code editor where you can inspect, modify, save, and download the code.
100+
</p>
93101

94-
The link launches a browser-based code editor where you can inspect, modify, save, and download the code.
95-
96-
:marked
97102
A few early pages are written as tutorials and are clearly marked as such.
98103
The rest of the pages highlight key points in code rather than explain each step necessary to build the sample.
99104
You can always get the full source through the #{_liveLink}.
100105

101106
## Reference pages
102107

103-
The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios.
104-
105-
The [Glossary](glossary.html) defines terms that Angular developers should know.
106-
107-
The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries.
108-
109-
## Feedback
110-
111-
We welcome feedback!
112-
113-
Use the [angular.io Github repo](https://github.com/angular/angular.io) for **documentation** issues and pull requests.
108+
- The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios.
109+
- The [Glossary](glossary.html) defines terms that Angular developers should know.
110+
- The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries.
114111

112+
## We welcome feedback!
115113

116-
Use the [Angular Github repo](https://github.com/angular/angular) to report issues with **Angular** itself.
114+
- Use the [website GitHub repo](!{_ngDocRepoURL}) for **documentation** issues and pull requests.
115+
- Use the [Angular GitHub repo](!{_ngRepoURL}) to report issues with **Angular** itself.

0 commit comments

Comments
 (0)