Skip to content

feat(docs-infra): add getting started widgets#26059

Closed
brandonroberts wants to merge 1 commit into
angular:masterfrom
brandonroberts:getting-started-widgets
Closed

feat(docs-infra): add getting started widgets#26059
brandonroberts wants to merge 1 commit into
angular:masterfrom
brandonroberts:getting-started-widgets

Conversation

@brandonroberts

@brandonroberts brandonroberts commented Sep 21, 2018

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[x] angular.io application / infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Small interactive widget components for getting started

@mary-poppins

Copy link
Copy Markdown

You can preview 2b8eaa9 at https://pr26059-2b8eaa9.ngbuilds.io/.

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The tests seem a little off. I didn't look through all of them carefully. The rest looks reasonable, but it would be better if we could see them in action 😉

Some observations:

  • Too much observables. Often seem unnecessary.
  • It would be nice if we could get rid of .template and derive it from the .result HTML. (That would make them more future proof too.)
  • If we expect to have more of these components in the future, it might make sense to make them more generic/configuration based. But they are fine for now imo.

Comment thread aio/src/app/custom-elements/getting-started/container/container.module.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/container/container.component.spec.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/container/container.component.spec.ts Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🤔

Comment thread aio/src/app/custom-elements/getting-started/ng-for/ng-for.component.ts Outdated
Comment thread aio/src/testing/dom-utils.ts Outdated
Comment thread aio/src/testing/dom-utils.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/ng-if/ng-if.module.ts Outdated
@mary-poppins

Copy link
Copy Markdown

You can preview 9f76b82 at https://pr26059-9f76b82.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview a4abdcf at https://pr26059-a4abdcf.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview fb59be2 at https://pr26059-fb59be2.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 9f50303 at https://pr26059-9f50303.ngbuilds.io/.

@brandonroberts

Copy link
Copy Markdown
Contributor Author

@gkalpak I've address your feedback with the observables and unnecessary tests. I didn't do anything with deriving the template from the results. I'll have to get some guidance add follow that with another PR. I'd like to get this landed first for Stephen, so we can iterate on the other getting started guide.

@brandonroberts

Copy link
Copy Markdown
Contributor Author

@gkalpak You can see the widgets on the /tutorial page temporarily. I will remove them before the PR lands.

@mary-poppins

Copy link
Copy Markdown

You can preview 34bddba at https://pr26059-34bddba.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 5db11b0 at https://pr26059-5db11b0.ngbuilds.io/.

@brandonroberts brandonroberts changed the title WIP: docs(docs-infra): add getting started widgets docs(docs-infra): add getting started widgets Sep 24, 2018
@jenniferfell jenniferfell added this to the v7.0 milestone Sep 24, 2018
@ngbot ngbot Bot removed this from the v7.0 milestone Sep 24, 2018

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

BTW, I would consider changing all widget selectors to ...-gs-... (instead of ...-getting-started-... for consistency. (The directory name should be a strong enough hint as to what gs stands for.)

Comment thread aio/src/app/custom-elements/getting-started/ng-for/ng-for.component.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/ng-for/ng-for.component.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/ng-for/ng-for.component.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/products.ts Outdated
Comment thread aio/src/app/app.module.ts Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What is this for?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Its needed for the tooltip that displayed when the JSON in invalid. I believe Angular Material needs to be at least version 6.1.x to lazy load the OverlayModule.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So, importing MatTooltipModule is not enough? That's weird. Is it because we lazy-load MatTooltipModule?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Its not enough to import MatTooltipModule. It throws an error with the Overlay provider being missing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Misunderstood. Yes its because MatTooltipModule is lazy loaded.

Comment thread aio/src/testing/dom-utils.ts Outdated
Comment thread aio/src/app/custom-elements/getting-started/ng-if/ng-if.component.ts Outdated
@gkalpak

gkalpak commented Sep 25, 2018

Copy link
Copy Markdown
Member

BTW, you can add the widgets in test.html (for showcase/review purposes).

@mary-poppins

Copy link
Copy Markdown

You can preview 536d2fa at https://pr26059-536d2fa.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 29fcf4c at https://pr26059-29fcf4c.ngbuilds.io/.

@brandonroberts brandonroberts added comp: docs target: major This PR is targeted for the next major release labels Sep 25, 2018
@brandonroberts brandonroberts requested review from StephenFluin and removed request for petebacondarwin September 26, 2018 12:54
@IgorMinar IgorMinar self-assigned this Oct 24, 2018
@brandonroberts brandonroberts force-pushed the getting-started-widgets branch from d98e78e to f25f968 Compare October 24, 2018 19:37
@brandonroberts brandonroberts added target: patch This PR is targeted for the next patch release and removed target: major This PR is targeted for the next major release labels Oct 24, 2018
@ngbot ngbot Bot added this to the needsTriage milestone Oct 24, 2018
@mary-poppins

Copy link
Copy Markdown

You can preview f25f968 at https://pr26059-f25f968.ngbuilds.io/.

@brandonroberts brandonroberts force-pushed the getting-started-widgets branch from f25f968 to de01285 Compare October 25, 2018 12:13
@mary-poppins

Copy link
Copy Markdown

You can preview de01285 at https://pr26059-de01285.ngbuilds.io/.

@IgorMinar IgorMinar added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Nov 2, 2018

@IgorMinar IgorMinar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good now on mobile. thanks!

I'm not happy about the size in increase, but we'll investigate that more once we switch to ivy.

Can you please:

  • rebase on master
  • squash into a single commit
  • prefix the commit with feat(docs-infra): ("docs(docs-infra)" means documentation for docs-infrastruture).

thanks!

@brandonroberts brandonroberts force-pushed the getting-started-widgets branch from de01285 to 62244a8 Compare November 2, 2018 13:48
@brandonroberts brandonroberts removed the request for review from StephenFluin November 2, 2018 13:48
@brandonroberts brandonroberts changed the title docs(docs-infra): add getting started widgets feat(docs-infra): add getting started widgets Nov 2, 2018
@brandonroberts brandonroberts force-pushed the getting-started-widgets branch from 62244a8 to 4f2014d Compare November 2, 2018 14:04
@brandonroberts brandonroberts added feature Label used to distinguish feature request from other issues effort3: weeks risk: low and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Nov 2, 2018
@ngbot ngbot Bot modified the milestones: needsTriage, Backlog Nov 2, 2018
@mary-poppins

Copy link
Copy Markdown

You can preview 4f2014d at https://pr26059-4f2014d.ngbuilds.io/.

@brandonroberts brandonroberts added the action: merge The PR is ready for merge by the caretaker label Nov 2, 2018
kara pushed a commit that referenced this pull request Nov 2, 2018
@kara kara closed this in affcbbd Nov 2, 2018
@brandonroberts brandonroberts deleted the getting-started-widgets branch November 2, 2018 18:11
@angular-automatic-lock-bot

Copy link
Copy Markdown

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.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Sep 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker cla: yes effort3: weeks feature Label used to distinguish feature request from other issues risk: low target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants