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

Introduce spread (...) more deliberately in various Bicep docs pages #15499

Open
anthony-c-martin opened this issue Nov 4, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@anthony-c-martin
Copy link
Member

As per feedback under #15451 (comment):

"The spread operator isn't well known or difficult to discover"

IMO, yes. I didn't know spread exists until just now; I had no trigger to think it might be used to solve this problem. When searching the internet, I did land on the "set or skip" github issue. I did not land on this particular example in the bicep spread documentation page.

And:

Maybe the bicep spread docs can be modified to more explicitly showcase the "conditionally set property on object" / "conditionally add element to array" usage pattern? I.e. make it more discoverable via internet search (SEO).
https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/operator-spread

Maybe add a note to the docs pages for if and ternary ? :, mentioning that you cannot use them for these use cases, that you need to use ... spread instead?

It sounds like we have some work to do on making this more discoverable and searchable in the Bicep docs. Creating this issue to track that.

@anthony-c-martin anthony-c-martin added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2024
@github-project-automation github-project-automation bot moved this to Todo in Bicep Nov 4, 2024
@stephaniezyen stephaniezyen added this to the v0.32 milestone Nov 6, 2024
@mumian mumian moved this from Todo to In Progress in Bicep Nov 12, 2024
@stephaniezyen stephaniezyen moved this from In Progress to In Review in Bicep Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: In Review
Development

No branches or pull requests

3 participants