Skip to content

Conversation

@alistairmatthews
Copy link
Contributor

Summary

The include file storage-bicep.md was referenced in both parent articles and in storage-app-host.md causing a long section of content to be repeated in all three Storage Integration articles. I've removed the reference to it from storage-app-host.md.

Fixes #4236

@IEvangelist
Copy link
Member

I think the best fix is to remove the bicep include from the parent articles and let the shared apphost include MD, be the only to reference the include.

Something like this:

  • Parent.md
    • AppHost.include
      • Bicep.include
  • SomeOtherParent.md
    • AppHost.include
      • Bicep.include

Does that make sense?

@alistairmatthews
Copy link
Contributor Author

Yeah, I considered that, but I think in that case, the content appears in the wrong place - immediately after "Adding a Storage Resource" you get a long section on Bicep, before returning to "Connect to an existing Azure Storage account", "Add Azure Storage emulator resource" and so on.

In my view, the article should cover all the ways of adding storage resources, then adding a queue resource (or whatever storage service you want), then customizing the Bicep. In which case the include has to be referenced from the three parent files.

WDYT? Happy to be overruled!

@IEvangelist
Copy link
Member

Yeah, I considered that, but I think in that case, the content appears in the wrong place - immediately after "Adding a Storage Resource" you get a long section on Bicep, before returning to "Connect to an existing Azure Storage account", "Add Azure Storage emulator resource" and so on.

In my view, the article should cover all the ways of adding storage resources, then adding a queue resource (or whatever storage service you want), then customizing the Bicep. In which case the include has to be referenced from the three parent files.

WDYT? Happy to be overruled!

I tend to agree with you. Right now, the issue is that all the other Azure content follows this same ordering, so we've kind of set an expectation. If you're up to it, you could move all the other bicep/provisioning includes out of their respective app host includes and into the parent articles. That would improve the flow of them all, it's just a bit of busy work.

@alistairmatthews
Copy link
Contributor Author

Yeah, I considered that, but I think in that case, the content appears in the wrong place - immediately after "Adding a Storage Resource" you get a long section on Bicep, before returning to "Connect to an existing Azure Storage account", "Add Azure Storage emulator resource" and so on.
In my view, the article should cover all the ways of adding storage resources, then adding a queue resource (or whatever storage service you want), then customizing the Bicep. In which case the include has to be referenced from the three parent files.
WDYT? Happy to be overruled!

I tend to agree with you. Right now, the issue is that all the other Azure content follows this same ordering, so we've kind of set an expectation. If you're up to it, you could move all the other bicep/provisioning includes out of their respective app host includes and into the parent articles. That would improve the flow of them all, it's just a bit of busy work.

No problem. I'll do that in a separate issue/PR.

@IEvangelist IEvangelist merged commit 72581da into dotnet:main Aug 19, 2025
9 checks passed
@alistairmatthews alistairmatthews deleted the remove-repeated-include-in-storage-integration-articles branch August 20, 2025 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Includes for Storage integration articles need fixing.

2 participants