docs: update readme and add FAQ #17814

jelbourn · 2019-11-26T01:46:07Z

Updates the readme to reflect the multi-package nature of the repo
Adds a Frequently Asked Questions page

StephenFluin

I left some minor feedback, but this looks like a really positive change!

StephenFluin · 2019-11-26T04:12:00Z

FAQ.md

+resources to provide more hands-on support. We recommend using [StackOverflow][] and [Gitter][] for
+more help.
+
+## Why doesn't this project provide support for application layouts?


"repo" might be a better word. "project" has an unclear meaning

StephenFluin · 2019-11-26T04:12:28Z

FAQ.md

+
+## What's your relationship to [MDC Web][]?
+
+MDC Web and Angular Material were created independently by two different teams inside Google.


Do they need the history? Can we just explain the current status?

I feel that the one sentence of context helps convey how we got to this point.

StephenFluin · 2019-11-26T04:14:06Z

README.md


-#### High level stuff planned for Q4 2019 (Oct  - Nov):
+## High level work planned for Q4 2019 (Oct  - Dec):


Why give dates? Why not just say "Future plans"

We've always listed what we're actively working on in the current quarter here. This isn't a target date, just a list of project we're spending time on.

StephenFluin · 2019-11-26T04:14:36Z

README.md

 * Remove dependency on HammerJS
 * Finish remaining test harnesses for Angular Material components
 * Continuing to create new, API-compatible versions of the Angular Material components backed by
-MDC Web ([see @jelbourn's ng-conf talk](https://youtu.be/4EXQKP-Sihw?t=891)).
+[MDC Web][] ([see @jelbourn's ng-conf talk](https://youtu.be/4EXQKP-Sihw?t=891)).
 * New `@angular/google-maps` package


I think this needs to be removed, right? It shipped!

It was still part of this quarter, so I'm going to leave it until January

crisbeto

LGTM

crisbeto · 2019-11-26T13:39:45Z

README.md


-#### High level stuff planned for Q4 2019 (Oct  - Nov):
+## High level work planned for Q4 2019 (Oct  - Dec):
 * Remove dependency on HammerJS


This is done already.

It was still part of this quarter, so I'm going to leave it until January

devversion

LGTM

* Updates the readme to reflect the multi-package nature of the repo * Adds a Frequently Asked Questions page

Splaktar · 2019-12-05T00:41:31Z

FAQ.md

+
+For every pull request, we run a presubmit against Google's internal test suite. This includes tests
+for all of the projects that use Angular CDK and Angular Material inside Google. As you might
+imagine, this process can be slow. Once this presubmit passes, PRs can generally be merged quickly.


slow -> time consuming, might be a better way of putting it 😄

Splaktar · 2019-12-05T00:43:12Z

FAQ.md

+For every pull request, we run a presubmit against Google's internal test suite. This includes tests
+for all of the projects that use Angular CDK and Angular Material inside Google. As you might
+imagine, this process can be slow. Once this presubmit passes, PRs can generally be merged quickly.
+When tests fail, however, the team has to spend time investigating before the PR can be merged.


merged or an issue with the changes can be identified.

Splaktar · 2019-12-05T00:43:35Z

FAQ.md

+for all of the projects that use Angular CDK and Angular Material inside Google. As you might
+imagine, this process can be slow. Once this presubmit passes, PRs can generally be merged quickly.
+When tests fail, however, the team has to spend time investigating before the PR can be merged.
+[Google uses a single monolithic code repository for its code, which everything at head][monorepo].


with everything at head?

Splaktar · 2019-12-05T00:48:58Z

FAQ.md

+
+Like any software team, we have limited time and resources. On top of the work we do in this repo,
+our team builds and maintains a smaller suite of Google-internal UI components and provides support
+to product teams inside Google using our components. We do our best to balance our time between bug


I wonder if it would be good to note the scale of these component's use within Google. I think that people would appreciate this more if they knew that this meant supporting x-hundred or x-thousand different teams. Obviously the number would be rough, but giving some idea of the scale might be helpful.

Splaktar · 2019-12-05T00:50:35Z

FAQ.md

+## Can you help debug my app?
+
+We can generally answer quick or straightforward questions. However, our team doesn't have the
+resources to provide more hands-on support. We recommend using [StackOverflow][] and [Gitter][] for


Are the forums also still considered a valid place for asking questions?

Splaktar · 2019-12-05T00:58:46Z

Sorry for the delay in taking a look at this. Overall it looks good!

EatonZ · 2019-12-16T00:33:46Z

FYI, the FAQ link is missing.

Splaktar · 2019-12-16T05:41:32Z

@EatonZ thank you, fixed in PR #17972.

angular-automatic-lock-bot · 2020-01-16T00:06:15Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

jelbourn added docs This issue is related to documentation pr: merge safe target: patch This PR is targeted for the next patch release labels Nov 26, 2019

jelbourn requested review from StephenFluin and Splaktar November 26, 2019 01:46

jelbourn requested a review from a team as a code owner November 26, 2019 01:46

googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 26, 2019

jelbourn force-pushed the readme-rewrite branch from 1436240 to 799f359 Compare November 26, 2019 04:02

StephenFluin approved these changes Nov 26, 2019

View reviewed changes

crisbeto approved these changes Nov 26, 2019

View reviewed changes

devversion approved these changes Nov 26, 2019

View reviewed changes

docs: update readme and add FAQ

5316b0d

* Updates the readme to reflect the multi-package nature of the repo * Adds a Frequently Asked Questions page

jelbourn force-pushed the readme-rewrite branch from 799f359 to 5316b0d Compare November 27, 2019 00:07

jelbourn merged commit f4d0c18 into angular:master Dec 3, 2019

Splaktar reviewed Dec 5, 2019

View reviewed changes

Splaktar mentioned this pull request Dec 16, 2019

docs(readme): fix link to FAQ #17972

Merged

angular-automatic-lock-bot bot locked and limited conversation to collaborators Jan 16, 2020


		## What's your relationship to [MDC Web][]?

		MDC Web and Angular Material were created independently by two different teams inside Google.


		#### High level stuff planned for Q4 2019 (Oct - Nov):
		## High level work planned for Q4 2019 (Oct - Dec):

docs: update readme and add FAQ #17814

docs: update readme and add FAQ #17814

Uh oh!

Conversation

jelbourn commented Nov 26, 2019

Uh oh!

StephenFluin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crisbeto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devversion left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Splaktar commented Dec 5, 2019

Uh oh!

EatonZ commented Dec 16, 2019

Uh oh!

Splaktar commented Dec 16, 2019

Uh oh!

angular-automatic-lock-bot bot commented Jan 16, 2020

Uh oh!

Uh oh!