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

Sentinel example needs clarification in README #573

Closed
lisamurphy-msft opened this issue Dec 14, 2021 · 1 comment · Fixed by #613
Closed

Sentinel example needs clarification in README #573

lisamurphy-msft opened this issue Dec 14, 2021 · 1 comment · Fixed by #613
Assignees
Labels
bug Something isn't working examples Related to content in the `src/bicep/examples` folder

Comments

@lisamurphy-msft
Copy link
Contributor

lisamurphy-msft commented Dec 14, 2021

Description

The Terraform example for deploying Sentinel does not make it clear that the purpose of the example is to show how to deploy a Terraform template after MLZ has been deployed using the Bicep template.

Expected Behavior

The first paragraph of the README should tell the reader that the template demonstrates how to deploy a Terraform template into a Mission Landing Zone instance that has been deployed using Bicep.

Actual Behavior

The README says that it's a Terraform template, but does not say why the example is useful.

@lisamurphy-msft lisamurphy-msft added bug Something isn't working documentation Improvements or additions to documentation core New feature or request and removed documentation Improvements or additions to documentation labels Dec 14, 2021
@lisamurphy-msft lisamurphy-msft changed the title Sentinel example Documentation does not mention bicep Sentinel example does not contain bicep implementation Dec 14, 2021
@brooke-hamilton brooke-hamilton removed core New feature or request needs triage labels Jan 11, 2022
@brooke-hamilton
Copy link
Contributor

brooke-hamilton commented Jan 11, 2022

@lisamurphy-msft I updated the description of the bug to add expected and actual behavior. We don't need an additional Bicep implementation of Sentinel (the core MLZ deployment already deploys Sentinel)--we need to tell readers why this example is here as Terraform deploying into an MLZ environment that was provisioned using Bicep.

I also updated the bug's title and removed the enhancement tag.

@brooke-hamilton brooke-hamilton changed the title Sentinel example does not contain bicep implementation Sentinel example needs clarification in README Jan 11, 2022
@brooke-hamilton brooke-hamilton self-assigned this Jan 14, 2022
@brooke-hamilton brooke-hamilton added the examples Related to content in the `src/bicep/examples` folder label Feb 6, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working examples Related to content in the `src/bicep/examples` folder
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants