Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(learn): Revise Angular tutorial for v17 #32701

Merged
merged 7 commits into from
Mar 19, 2024
Merged

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Mar 15, 2024

Description

There were some errors in the Angular tutorial and some fixes have landed, but there was a need to follow through the steps again from the beginning to make sure everything works as expected.

This PR uses 17.3.0 (current when using npm install -g @angular/cli at time of writing).

Motivation

Keeping the tutorials using frameworks error-free at the very least.

Related issues and pull requests

@bsmth bsmth requested a review from a team as a code owner March 15, 2024 15:56
@bsmth bsmth requested review from Elchi3 and removed request for a team March 15, 2024 15:56
@github-actions github-actions bot added Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees size/m [PR only] 51-500 LoC changed labels Mar 15, 2024
Copy link
Contributor

github-actions bot commented Mar 15, 2024

Preview URLs

Flaws (1)

Note! 4 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Angular_getting_started
Title: Getting started with Angular
Flaw count: 1

  • macros:
    • Unknown macro title
External URLs (24)

URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Angular_todo_list_beginning
Title: Beginning our Angular todo list app


URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Angular_item_component
Title: Creating an item component


URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Angular_building
Title: Building Angular applications and further resources


URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Angular_getting_started
Title: Getting started with Angular

(comment last updated: 2024-03-19 10:36:16)

@OnkarRuikar
Copy link
Contributor

A few more changes. In Angular_getting_started, the angular doesn't support current version it seems only LTS versions are supported. So the statement needs to be

Angular requires a active LTS or maintenance LTS.

May I get edit permissions to learn-angular-v17 branch?

@bsmth
Copy link
Member Author

bsmth commented Mar 16, 2024

A few more changes. In Angular_getting_started, the angular doesn't support current version it seems only LTS versions are supported. So the statement needs to be

Angular requires a active LTS or maintenance LTS.

Nice one, thanks for spotting.

May I get edit permissions to learn-angular-v17 branch?

Sure! I've sent you an invite for my fork, you should get access 🙌🏻

bsmth and others added 3 commits March 17, 2024 14:22
@OnkarRuikar
Copy link
Contributor

The ngFor and ngIf are old control flow mechanisms.
Can we switch to the new Built-in control flow in our tutorial?

-- <li *ngFor="let item of items">{{item.description}}</li>
++ @for (item of items) {
++   <li>{{item.description}}</li>
++ }

@bsmth
Copy link
Member Author

bsmth commented Mar 18, 2024

The ngFor and ngIf are old control flow mechanisms. Can we switch to the new Built-in control flow in our tutorial?

-- <li *ngFor="let item of items">{{item.description}}</li>
++ @for (item of items) {
++   <li>{{item.description}}</li>
++ }

I like how it looks, they're in "developer preview" - shall we update this when they're "stable"? Angular 18 is on the way, so maybe we hold off on these types of changes until then.

@OnkarRuikar
Copy link
Contributor

Angular 18 is on the way, so maybe we hold off on these types of changes until then.

Around two months from now. Let's add the new stuff after that.

@bsmth
Copy link
Member Author

bsmth commented Mar 18, 2024

Around two months from now. Let's add the new stuff after that.

Sounds good to me! Are your changes ready to land? I think we can merge shortly

@OnkarRuikar
Copy link
Contributor

Sounds good to me! Are your changes ready to land?

Yes

@bsmth
Copy link
Member Author

bsmth commented Mar 19, 2024

Thanks @OnkarRuikar - do you want to leave a review so we can merge (no author self-approval)?

@OnkarRuikar
Copy link
Contributor

Thanks @OnkarRuikar - do you want to leave a review so we can merge (no author self-approval)?

I don't have approve rights in this repo.

Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

A few minor tweaks and a suggestion. Otherwise, looks good to me :) Thanks!

Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>
@bsmth
Copy link
Member Author

bsmth commented Mar 19, 2024

Thanks, both - going to merge shortly!

@bsmth bsmth merged commit 4d26e2f into mdn:main Mar 19, 2024
9 checks passed
@bsmth bsmth deleted the learn-angular-v17 branch March 19, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants