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

docs(guide & api): feedback/issue links for Dart should refer to Dart repos #2821

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions public/_includes/_util-fns.jade
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
3 changes: 3 additions & 0 deletions public/docs/dart/latest/_util-fns.jade
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
13 changes: 8 additions & 5 deletions public/docs/dart/latest/api/index.jade
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
include ../_util-fns

:marked
> **Known issues:** The angular.io issue tracker contains [all known
issues][api-issues]; if you notice others, please [report
them][new-issue]. Thanks!
> **Known issues:** The Angular issue tracker contains
[all known issues][api-issues]; if you notice others, please
[report them][new-issue]. Thanks!

[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
[new-issue]: !{_ngRepoURL}/issues/new?title=%5BAPI%20docs%5D
[api-issues]: !{_ngRepoURL}/issues
//- ?q=label%3Aapi

api-list(src="api-list.json" lang="dart")
9 changes: 0 additions & 9 deletions public/docs/dart/latest/guide/index.jade
Original file line number Diff line number Diff line change
Expand Up @@ -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/.
53 changes: 26 additions & 27 deletions public/docs/ts/latest/guide/index.jade
Original file line number Diff line number Diff line change
Expand Up @@ -9,51 +9,59 @@ figure
are building client applications in HTML and #{_Lang}.
<br class="l-clear-left">

:marked
## Organization

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

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 <b>QuickStart</b>
td <b><a href="../quickstart">QuickStart</a></b>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little weird to have links on QuickStart but not on Guide & Advanced... But it is definitely handy to have these links, especially for those times when the window is too narrow to display the sidenav.

This is a case where having everything in the guide/ directory is coming back to bite us.

Maybe we should try this out and see if anyone objects?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I excluded guide, because this page is the link to the Guide. Do you want me to add a self link?

This is a case where having everything in the guide/ directory is coming back to bite us.
Yes.

Maybe we should try this out and see if anyone objects?
Agreed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I don't think a self-link is helpful. We could maybe briefly mention in the text that that's where they are.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I was thinking about that, but wasn't sure how to adjust the text.)

td
:marked
The foundation for every page and sample in this documentation.
tr(style=top)
td <b>Guide</b>
td <b><a href="./">Guide</a></b>
td
:marked
The essential ingredients of Angular development.
tr(style=top)
td <b>API Reference</b>
td <b><a href="../api">API Reference</a></b>
td
:marked
Authoritative details about each member of the Angular libraries.
tr(style=top)
td <b>Tutorial</b>
td <b><a href="../tutorial">Tutorial</a></b>
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 <b>Advanced</b>
td <b><a href="!{advancedUrl}">Advanced</a></b>
td
:marked
In-depth analysis of Angular features and development practices.
tr(style=top)
td <b>Cookbook</b>
td <b><a href="../cookbook">Cookbook</a></b>
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:
Expand All @@ -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 <live-example name="architecture"></live-example> 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 <live-example name="architecture"></live-example> from the [Architecture](architecture.html) page.
<p if-docs="ts">
The link launches a browser-based code editor where you can inspect, modify, save, and download the code.
</p>

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 [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.

## Feedback

We welcome feedback!

Use the [angular.io Github repo](https://github.com/angular/angular.io) for **documentation** issues and pull requests.
- 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.

## We welcome feedback!

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.