ng-zorro-antd icon indicating copy to clipboard operation
ng-zorro-antd copied to clipboard

Update snippet code documentation with the new code flow

Open Nicoss54 opened this issue 1 year ago • 13 comments

What problem does this feature solve?

Currently all the snippet code use the older code flow of Angular using ngIf ngFor and ngSwitchDirective

It will be great if the snippet use the new code flow of Angular

What does the proposed API look like?

Replace ngIf ngFor and ngSwitch by the respect @-syntax code flow

Nicoss54 avatar Dec 02 '23 11:12 Nicoss54

@OriginRing @HyperLife1119 @simplejason are you agree with that ? It it's ok i will begin the work :)

Nicoss54 avatar Dec 02 '23 11:12 Nicoss54

I agree with this suggestion!

HyperLife1119 avatar Dec 02 '23 11:12 HyperLife1119

I agree with this suggestion!

I take the point

Nicoss54 avatar Dec 02 '23 11:12 Nicoss54

Just out of curiosity, won't it have any effect on maintaining older version? Does ng-zorro even continue to support it's older versions?

ParsaArvanehPA avatar Dec 02 '23 18:12 ParsaArvanehPA

Just out of curiosity, won't it have any effect on maintaining older version? Does ng-zorro even continue to support it's older versions?

I don’t totally understand, with this issue I will update the documentation snippet with the new code flow, also i will migrate components on the new code flow.

This will impact the version 17 of ng-zorro. Previous version will not be impacted.

I don’t know If I answer to your curiosity correctly :)

Nicoss54 avatar Dec 02 '23 21:12 Nicoss54

Just out of curiosity, won't it have any effect on maintaining older version? Does ng-zorro even continue to support it's older versions?

I don’t totally understand, with this issue I will update the documentation snippet with the new code flow, also i will migrate components on the new code flow.

This will impact the version 17 of ng-zorro. Previous version will not be impacted.

I don’t know If I answer to your curiosity correctly :)

Sorry I was a bit vague, let me explain what I meant in my previous message: Imagine this scenario that ng-zorro supports it's 3 latest versions, that means that currently version number 17 and 16 and 15 needs to be maintained. Normally when a bug is fixed in version 17, it is cherry-picked via git to branches /16.x and /15.x.

Now my question is that whatever ng zorro supports several versions or just it's latest version. Because if it supports several versions, maybe it's not a good idea to move to new code flow now, because it will make automatic cherry-pick not possible, and whenever a bug is fixed it should be manually cherry-picked which can be very time consuming.

ParsaArvanehPA avatar Dec 04 '23 08:12 ParsaArvanehPA

Just out of curiosity, won't it have any effect on maintaining older version? Does ng-zorro even continue to support it's older versions?

I don’t totally understand, with this issue I will update the documentation snippet with the new code flow, also i will migrate components on the new code flow. This will impact the version 17 of ng-zorro. Previous version will not be impacted. I don’t know If I answer to your curiosity correctly :)

Sorry I was a bit vague, let me explain what I meant in my previous message: Imagine this scenario that ng-zorro supports it's 3 latest versions, that means that currently version number 17 and 16 and 15 needs to be maintained. Normally when a bug is fixed in version 17, it is cherry-picked via git to branches /16.x and /15.x.

Now my question is that whatever ng zorro supports several versions or just it's latest version. Because if it supports several versions, maybe it's not a good idea to move to new code flow now, because it will make automatic cherry-pick not possible, and whenever a bug is fixed it should be manually cherry-picked which can be very time consuming.

Normally we support only the current version, if @OriginRing can confirm this it will be great. But This issue is just an update doc issue, I will just ypdate the snippet code of component documentation not the component business logic

Nicoss54 avatar Dec 04 '23 09:12 Nicoss54

Just out of curiosity, won't it have any effect on maintaining older version? Does ng-zorro even continue to support it's older versions?

I don’t totally understand, with this issue I will update the documentation snippet with the new code flow, also i will migrate components on the new code flow. This will impact the version 17 of ng-zorro. Previous version will not be impacted. I don’t know If I answer to your curiosity correctly :)

Sorry I was a bit vague, let me explain what I meant in my previous message: Imagine this scenario that ng-zorro supports it's 3 latest versions, that means that currently version number 17 and 16 and 15 needs to be maintained. Normally when a bug is fixed in version 17, it is cherry-picked via git to branches /16.x and /15.x. Now my question is that whatever ng zorro supports several versions or just it's latest version. Because if it supports several versions, maybe it's not a good idea to move to new code flow now, because it will make automatic cherry-pick not possible, and whenever a bug is fixed it should be manually cherry-picked which can be very time consuming.

Normally we support only the current version, if @OriginRing can confirm this it will be great. But This issue is just an update doc issue, I will just ypdate the snippet code of component documentation not the component business logic

Oh my bad, I thought you were talking about changing the component's business logic :)

ParsaArvanehPA avatar Dec 04 '23 12:12 ParsaArvanehPA

More about the ng-zorro support, as mentioned here a lot of future changes may depend on knowing the answer to as how many prior released versions should be maintained.

If we want to follow Angular on LTS support, we should support the releases made in the last 18 months: Angular LTS support For environment support we currently follow their policy

ParsaArvanehPA avatar Dec 05 '23 08:12 ParsaArvanehPA

More about the ng-zorro support, as mentioned here a lot of future changes may depend on knowing the answer to as how many prior released versions should be maintained.

If we want to follow Angular on LTS support, we should support the releases made in the last 18 months: Angular LTS support For environment support we currently follow their policy

If i'm not wrong we don't support the previous version of Ng-Zorro but i'm not sure about that. If @OriginRing or @simplejason can confirm or not this supposition it will be great.

But this issue is just for snippet exemple code so no problems currently

Nicoss54 avatar Dec 05 '23 08:12 Nicoss54

@Nicoss54 The previous version will not be maintained with out major errors, so you can start working on the replacement.

super, first PR done for auto complete :)

OriginRing avatar Dec 07 '23 05:12 OriginRing

Would you mind if I join you on these tasks? @Nicoss54

ParsaArvanehPA avatar Dec 14 '23 17:12 ParsaArvanehPA

Would you mind if I join you on these tasks? @Nicoss54

@ParsaArvanehPA its should be nice to work together on this, unfortunately it will be complicated, and it will be a high risk of doing the same work or have conflicts :/

Nicoss54 avatar Dec 14 '23 18:12 Nicoss54

As I can see, this work had been done, and I'd like to close this issue. Thank you everyone for this fantacy work!

Laffery avatar Jun 30 '24 05:06 Laffery