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 HTMLVersionInline macro #2506

Closed
wants to merge 1 commit into from
Closed

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Jan 13, 2021

I've removed all calls for this macro in mdn/content and the macro isn't called from another macro. In the old world, I would also check translations and remove calls there, but I'm not sure how to do that now.

So, in theory this would be one macro less to worry about but I marked it as a draft because I'd like to hear about the process for translations first. Thanks! ❤️

@ghost
Copy link

ghost commented Jan 13, 2021

At the moment my ideal translation process is a bot that automatically translates and creates a PR on another repository. This thing happens from every repository on every repository.

@peterbe
Copy link
Contributor

peterbe commented Jan 13, 2021

@fiji-flo If we merge this, some 200 pages in the translated content, when we uplift all, will get KumaScript rendering flaws on all of these.

@peterbe
Copy link
Contributor

peterbe commented Jan 13, 2021

@Elchi3 For the record...
A) you can set BUILD_MACROS_USED_LOGFILE to get a dump of all macros invoked. If you run yarn build (no filtering) you should be able to complement your grep'ing too.
B) I love the idea of deleting one macro at a time. A better approach than attempting to delete them all at the same time. e.g. #1274 and #1727

@Elchi3
Copy link
Member Author

Elchi3 commented Jan 13, 2021

@fiji-flo If we merge this, some 200 pages in the translated content, when we uplift all, will get KumaScript rendering flaws on all of these.

Would you accept a PR to https://github.com/mdn/translated-content to fix this and then merge this PR to remove the macro? Or are we fine with having flaws in translations?

@fiji-flo
Copy link
Contributor

If it's a simple sed command on the translated content we should start writing them down in an issue and we run them before uplifting. I'm right now starting to gather them to, e.g. IncludeSubnav.

I just started an issue to have something for now.

@peterbe
Copy link
Contributor

peterbe commented Jan 15, 2021

I propose we leave this as a draft until the translated content has all been uplifted.

Base automatically changed from master to main February 16, 2021 16:38
@Elchi3
Copy link
Member Author

Elchi3 commented Feb 26, 2021

I saw other macros got removed, so ready for review/merge now?

@Elchi3 Elchi3 marked this pull request as ready for review February 26, 2021 10:12
@peterbe
Copy link
Contributor

peterbe commented Feb 26, 2021

Still used in a lot of translated content. ...now that they are all kumascript rendered:

MOZILLA/MDN/translated-content  main ✔
▶ rg -i HTMLVersionInline  | wc -l
    1288

We do have a plan to write a flaw checker thing, for translated documents only, that highlights what and how out-of-date a translated document is based on analyzing things that are easy to analyze. For example, the presence of certain macros.
But we don't have that tooling yet.

The original idea was to pick a couple of KS macros we love and think are important. E.g. Compat, InteractiveExamples, LiveSamples etc.
But I think we could also consider analyzing all macros. Perhaps, if a translated document uses a macro that the English page does NOT, that's a flaw. I.e. "excess legacy macros" :)

@Elchi3
Copy link
Member Author

Elchi3 commented Mar 1, 2021

Okay, closing this until there is something in place to deal with translations.

@Elchi3 Elchi3 closed this Mar 1, 2021
@Elchi3 Elchi3 deleted the rm-htmlversioninline branch March 1, 2021 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants