-
Notifications
You must be signed in to change notification settings - Fork 146
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
Change the directory structure of the src/bicep
folder
#561
Comments
Before implementing this, we need to do a couple of things with the proposed structure:
|
Another input on this: we had feedback related to auto-generating documentation that each template should be in its own folder so that a README.md document can be generated within the same folder to show parameter docs. That would be in alignment with the Terraform templates. |
Based on discussions above, here's another proposal for the directory structure in
|
Seems to cross streams between opinion and none opinion in modules, also appears very busy with separate folders in core and separate read me. Can't core modules just include comments and descriptions. |
Looks really great. Out of curiosity, do we need a hub-network-peering.bicep module in tiers as we have same module in core directory? |
Good point that it's inconsistent to have each template in a subfolder in
I'm 100% OK with any of these options. It's true that having subfolders for every module is busy and causes longer paths. |
Good call: those two modules appear to be nearly exact copies. Yes I think we can remove the one in |
Proposed updates to acceptance criteria and updated folder structure:
|
I think that's a step in the right direction and is actionable today. Glancing into the crystal ball, if there's ever intent to machine generate
I want to say this is similar to the out-of-the-box directory structure required for some of the Terraform docs generations tools, but @Chambras can correct me where I'm wrong. |
I think we need the folders for the add-ons and examples, for the reasons you said, and also because we are going to implement a standard pattern for those which provides examples for several ways to set parameters. For the However, the drawback of creating the folders in We could say YAGNI for now and add the folders when we need them, which would have the benefit of being simple now and the drawback of maybe having yet another folder structure change later (better to do it all at once.) Or we could say do it now because we think nested folders will be needed, which would have the benefit of preventing two separate refactorings and the drawback of complexity that isn't useful right away. |
Based on team consensus we will have no subfolders in I will update the acceptance criteria to align with this. |
Done. |
Benefit/Result/Outcome
Improved folder structure for the
src/bicep
folder.Description
This is based on a discussion in #532.
Acceptance Criteria
core
folder that are scoped to MLZ concepts, like spoke network, and call modules in themodules
folder. Generally, modules in this folder will execute modules in themodules
folder.modules
folder that are scoped to Azure concepts, like storage accounts. Generally, a module in this folder will not execute other modules.newWorkload
totier3
to match the name of the Terraform template.The text was updated successfully, but these errors were encountered: