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

Allow the browser-compat frontmatter value to be an array #5972

Closed
wants to merge 1 commit into from
Closed

Allow the browser-compat frontmatter value to be an array #5972

wants to merge 1 commit into from

Conversation

sideshowbarker
Copy link
Member

@sideshowbarker sideshowbarker commented Apr 13, 2022

We currently have some existing documents that use multiple {{Compat(...)}} macros within the same document — because without the browser-compat frontmatter key being allowed to contain an array, there’s no other way to have multiple BCD tables in the same document except by putting multiple {{Compat(...)}} macros in the document.

So, allowing the browser-compat value to contain an array eliminates the need for authors to put multiple {{Compat(...)}} macros in a document.

And reducing the need for authors to use the {{Compat(...)}} macro at all is also in line with our general de-macro-ization plans — in that it takes us a big step closer to completely eliminating the {{Compat}} macro altogether.


Part of the context for this change is that #5347 (reply in thread) has persuaded me that it would be a good idea for us to move wholly over to just using the browser-compat and spec-urls macros, and never using the {{Specifications}} and {{Compat}} macros.

The specific parts of #5347 (reply in thread) I found persuasive were:

Macros with arguments

...
…my preferences are toward:

  1. Providing fewer ways to author things. Either the key is the only way it's done, or there ought be more unified way of richly citing/embedding non-MDN content.
  2. Not committing to Kumascript-isms in Markdown.

In general, I'd really like to get away from macros as a way of embedding stuff in Markdown and it didn't feel like it was in scope for this discussion. That said, I'd like us to explore alternatives to Kumascript macro syntax, particularly the bits that are most unlike Markdown (in this case, arguments).

We currently have some existing documents that use multiple
{{Compat(...)}} macros within the same document — because without the
browser-compat frontmatter key being allowed to contain an array,
there’s no other way to have multiple BCD tables in the same document
except by putting multiple {{Compat(...)}} macros in the document.

So, allowing the browser-compat value to contain an array eliminates the
need for authors to put multiple {{Compat(...)}} macros in a document.

And reducing the need for authors to use the {{Compat(...)}} macro at all
is also in line with our general de-macro-ization plans — in that it takes
us a big step closer to completely eliminating the {{Compat}} altogether.
@caugner caugner added the 🧑‍🤝‍🧑 community contributions by our wonderful community label May 12, 2022
@github-actions github-actions bot added the merge conflicts 🚧 Please rebase onto or merge the latest main. label May 16, 2022
@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before we can merge this.

@caugner
Copy link
Contributor

caugner commented Jun 3, 2022

Closing in favor of #6464.

@caugner caugner closed this Jun 3, 2022
@sideshowbarker sideshowbarker deleted the sideshowbarker/browser-compat-frontmatter-key-allow-array branch June 3, 2022 17:17
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 merge conflicts 🚧 Please rebase onto or merge the latest main.
Projects
Development

Successfully merging this pull request may close these issues.

2 participants