question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Rewrite Getting Started Guide

See original GitHub issue

Documentation Feedback

I think that we should do more in our docs to highlight the happy path that is ng add @angular/material and the prompts / options we offer. Currently, we mention it only as a sub-bullet alternative (https://material.angular.io/guide/getting-started#alternative-2-angular-devkit-6-) and then continue on with telling the developer how to manually configure everything.

We cover ng add a bit better in https://material.angular.io/guide/schematics#install-schematics, but a new user is going to look at the “Getting Started Guide” first.

This was also reported in https://github.com/angular/components/issues/14380.

How would we want to solve this?

  • Linking from Getting Started to the Schematics Guide?
  • Or totally re-writing the Getting Started Guide to highlight ng add and move the manual config to alternative steps at the end?

Affected documentation page: https://material.angular.io/guide/getting-started

Jeremy mentioned that @manughub has already started working on this but that there was no issue to track it.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
manughubcommented, Jul 30, 2019

Yes that’s fine.

I have the PR ready to go for getting started with Material and it will be out for review shortly.

-Manu

On Mon, Jul 29, 2019 at 6:14 PM Michael Prentice notifications@github.com wrote:

It seems like a separate “Getting Started with the CDK” guide would be useful as well. Should I open a separate issue for that? We have a number of projects that use the CDK that we could link to in addition to some useful videos for getting started.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/angular/components/issues/16426?email_source=notifications&email_token=AH4EYCXNJA4GWD4HQJLP4I3QB6IXTA5CNFSM4H47N2CKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3COGYI#issuecomment-516219745, or mute the thread https://github.com/notifications/unsubscribe-auth/AH4EYCURTIB7QMXPHZQQUY3QB6IXTANCNFSM4H47N2CA .

1reaction
manughubcommented, Jul 25, 2019

Update: I’ve rewritten the getting started guide and reviewed with @jelbourn. Working on the PR and expect to have it out for review this week.

Read more comments on GitHub >

github_iconTop Results From Across the Web

rewrite-docs/getting-started.md at master - GitHub
This guide covers configuring rewrite with Maven or Gradle and using it to run refactoring recipes. Quickstart: Setting Up Your Project and Running...
Read more >
URL Rewriting for Beginners | Alone On A Hill
A beginner's guide to URL rewriting, with plenty of examples.
Read more >
mod_rewrite Tutorial for Absolute Beginners - ELATED.com
Explains what mod_rewrite is and how to use it. Includes 3 practical examples: 301 redirects, creating friendly URLs, and blocking image ...
Read more >
mod_rewrite: A Beginner's Guide to URL Rewriting - Part 1
This article was written in 2002 and remains one of our most popular posts. If you're keen to learn more about URLs, you...
Read more >
Introduction To URL Rewriting - Smashing Magazine
URL rewriting changes all that. It allows you to completely separate the URL from the resource. With URL rewriting, you could have taking...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found