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

Remove TemplateLink macro #4848

Closed
Tracked by #5179 ...
hamishwillee opened this issue Oct 29, 2021 · 11 comments
Closed
Tracked by #5179 ...

Remove TemplateLink macro #4848

hamishwillee opened this issue Oct 29, 2021 · 11 comments
Labels
🧑‍🤝‍🧑 community contributions by our wonderful community 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. macros tracking issues related to kumascript macros needs decision from engineering

Comments

@hamishwillee
Copy link
Contributor

This wasn't particularly useful and has been removed from en-US source in mdn/content#9914

Should it also be removed in Yari?

I have taken no action on translated content.

@escattone
Copy link
Contributor

@hamishwillee Yes, we can remove the TemplateLink macro as soon as it is no longer used within the translated-content. I see that there are still about 43 translated documents that use it.

@schalkneethling
Copy link

There still are 38 files that use this macro extensively. Do we have a way to mark a macro as deprecated with a date when it will be removed? I am thinking we need it if we do not already have it.

@hamishwillee
Copy link
Contributor Author

hamishwillee commented Jan 30, 2022

There still are 38 files that use this macro extensively.

Sorry, I thought I'd removed all of them - at least in English content.

Do we have a way to mark a macro as deprecated with a date when it will be removed? I am thinking we need it if we do not already have it.

I would assume not. I suspect that the right way to do this is co-ordinate a project with content team. But it is complicated if these cases are in translations, since no one owns those. I don't even know where the translations live.

@escattone That would be a question for you.

@schalkneethling
Copy link

There still are 38 files that use this macro extensively.

Sorry, I thought I'd removed all of them - at least in English content.

Do we have a way to mark a macro as deprecated with a date when it will be removed? I am thinking we need it if we do not already have it.

I would assume not. I suspect that the right way to do this is co-ordinate a project with content team. But it is complicated if these cases are in translations, since no one owns those. I don't even know where the translations live.

@escattone That would be a question for you.

Hey @hamishwillee, @escattone is no longer at Mozilla :( @Rumyra, @ddbeck I am also curious which macros we can remove, render out etc. We should have a chat about this

@Rumyra
Copy link
Contributor

Rumyra commented Jan 31, 2022

Yes we should have a chat about it - I can discuss with translated-content with what we decide 👍

@hamishwillee
Copy link
Contributor Author

You might want to talk to @wbamberg about what the previous plan for removal of macros was. I'm working on the Page macro but I think there was a list somewhere of the first macros to be removed. Some can't be removed of course unless we have a different approach for sidebars etc. Would like to be kept in the loop please.

@wbamberg
Copy link
Collaborator

wbamberg commented Feb 1, 2022

There still are 38 files that use this macro extensively.

Sorry, I thought I'd removed all of them - at least in English content.

I didn't see any in mdn/content. I do see 385 in translated-content, and as Hamish says, that's a big problem with actually removing macros. Florian and I had the same problem back when we were trying to remove macros. For example all the old Compat* macros, like for example CompatGeckoDesktop, which appears 0 times in mdn/content (and has not appeared in en-US for about 4 years) but appears 3985 times in translated-content. There are about 10 just of these Compat* macros.

You might want to talk to @wbamberg about what the previous plan for removal of macros was.

I wrote a thing about this about a hundred years ago, most of which seems to still apply: https://docs.google.com/document/d/1G5KwoJNi8mLmbzcWo-eawH0xw4spVvHGY4Wc4ZEuMYg/edit.

I think at the time I wrote that though I thought moving to a new platform meant we would need to deal with KS, but I'm no longer so sure about that. For one thing, we are on a new platform now. So I guess at the moment I think we should focus more on removing macros where that can deliver other value than just "fewer macros".

For instance, I think we should:

  • start generating "experimental" and "deprecated" banners from BCD, and as part of that we should remove the macros.
  • remove page (1) because it's a content antipattern IMO and (2) because it's one of the two macros that makes KS a lot more complicated than it needs to be (although there's no actual value in that unless we also go ahead with the KS refactoring that it enables).
  • have a new way of building sidebars that's not macro-based, because it would be more reliable, more consistent, and easier to use.

I think if time/labour were unlimited a project to just remove macros would be worth doing, but they're not.

@schalkneethling
Copy link

  • start generating "experimental" and "deprecated" banners from BCD, and as part of that we should remove the macros.

@wbamberg If you want to chat about getting on the roadmap for MDN Web Docs engineering, please let me know.

@wbamberg
Copy link
Collaborator

wbamberg commented Feb 1, 2022

Thanks @schalkneethling ! We have openwebdocs/project#81 for it, and I hope we might be able to get started on it in Q2?

@schalkneethling
Copy link

Thanks @schalkneethling ! We have openwebdocs/project#81 for it, and I hope we might be able to get started on it in Q2?

Sounds doable to me.

@github-actions github-actions bot added the idle label Apr 15, 2022
@schalkneethling schalkneethling added 🧑‍🤝‍🧑 community contributions by our wonderful community macros tracking issues related to kumascript macros and removed idle labels Apr 17, 2022
@github-actions github-actions bot added the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label May 25, 2022
@caugner
Copy link
Contributor

caugner commented Aug 18, 2022

As of today, the TemplateLink macro is deprecated, but still used in es/ru/pt-br locales. There is an ongoing and very active effort to remove deprecated macros from translated-content, yet it's not necessary to track the removal of individual deprecated macros in a yari issue.

@caugner caugner closed this as not planned Won't fix, can't repro, duplicate, stale Aug 18, 2022
Repository owner moved this from Backlog to Done in Yari Platform Engineering Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍🤝‍🧑 community contributions by our wonderful community 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. macros tracking issues related to kumascript macros needs decision from engineering
Projects
Development

No branches or pull requests

6 participants