Skip to content

Commit fcd5920

Browse files
YaelSchusterYaelSchuster
committed
formatting
1 parent c52b803 commit fcd5920

File tree

2 files changed

+154
-0
lines changed

2 files changed

+154
-0
lines changed

‎.github/agents/blogs.agent.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Based on the approved outline, the user's requirements, and research findings, c
8282

8383
Review the provided content and improve it to align with Microsoft's writing style guidelines. Key guidelines to enforce include:
8484

85+
- The returned format is HTML only. Do not include any other format or markdown.
8586
- Follow Microsoft documentation style guidelines: https://learn.microsoft.com/en-us/style-guide/welcome/
8687
- **Use plain, inclusive language**
8788
- **Use present tense** - "This feature lets you..." not "This feature will let you..."
@@ -95,7 +96,10 @@ Based on the approved outline, the user's requirements, and research findings, c
9596
# Phase 6: Review and Finalize
9697

9798
<workflow>
99+
100+
98101
Review the entire document for clarity, coherence, and completeness. Ensure that:
102+
- The returned format is HTML only. Do not include any other format or markdown.
99103
- The content meets the user's requirements
100104
- The information is accurate and up-to-date
101105
- The document flows logically and is easy to read

‎.github/agents/templates/reference-architecture.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<!--
2+
Don't add metadata to this Markdown file.
3+
Use the browser header template to create a YAML file that contains your metadata.
4+
Add a brief introductory paragraph with no heading.
5+
-->
6+
7+
## Architecture
8+
9+
<!-- Use the following format to add your image file:-->
10+
11+
:::image type="complex" border="false" source="./images/<file-name-and-extension>" alt-text="Diagram that shows the <solution name> architecture." lightbox="./images/<file-name-and-extension>":::
12+
<Long description that ends with a period.>
13+
:::image-end:::
14+
15+
<!-- The following link will work after the AAC team uploads your Visio or PowerPoint file to the Azure CDN. -->
16+
17+
*Download a [Visio file](https://arch-center.azureedge.net/<file-name>.vsdx) of this architecture.*
18+
19+
### Dataflow
20+
21+
<!-- If your scenario doesn't include data, title this section "Workflow". -->
22+
23+
The following dataflow corresponds to the previous diagram:
24+
25+
<!-- Add a numbered list for the steps in your architecture diagram. -->
26+
27+
### Components
28+
29+
<!--
30+
Add a bulleted list of all components in the architecture.
31+
Where possible, link to the component's Well-Architected Framework service guide.
32+
Alternatively, link to the product's documentation page.
33+
-->
34+
35+
### Alternatives
36+
37+
<!-- List alternative Azure services or approaches for this solution. -->
38+
39+
## Scenario details
40+
41+
<!-- Explain the business problem and why this scenario was built to solve it. -->
42+
43+
### Potential use cases
44+
45+
<!-- List any other use cases or industries where this scenario would be a good fit. -->
46+
47+
## Recommendations
48+
49+
You can apply the following recommendations to most scenarios. Follow these recommendations unless you have a specific requirement that overrides them.
50+
51+
<!-- Explain considerations for how to deploy or configure the elements of this architecture.-->
52+
53+
## Considerations
54+
55+
<!--REQUIRED STATEMENT: Include the following statement to introduce this section:-->
56+
57+
These considerations implement the pillars of the Azure Well-Architected Framework, which is a set of guiding tenets that you can use to improve the quality of a workload. For more information, see [Well-Architected Framework](/azure/well-architected/).
58+
59+
<!-- Include ALL of the following H3 sub-sections, in the following order. -->
60+
61+
### Reliability
62+
63+
<!--REQUIRED STATEMENT: Include the following statement to introduce the section:-->
64+
65+
Reliability helps ensure that your application can meet the commitments that you make to your customers. For more information, see [Design review checklist for Reliability](/azure/well-architected/reliability/checklist).
66+
67+
<!-- Explain resiliency and availability considerations. -->
68+
69+
### Security
70+
71+
<!--REQUIRED STATEMENT: Include the following statement to introduce the section:-->
72+
73+
Security provides assurances against deliberate attacks and the misuse of your valuable data and systems. For more information, see [Design review checklist for Security](/azure/well-architected/security/checklist).
74+
75+
<!-- Explain security, identity, and data sovereignty considerations. -->
76+
77+
### Cost Optimization
78+
79+
<!--REQUIRED STATEMENT: Include the following statement to introduce the section:-->
80+
81+
Cost Optimization focuses on ways to reduce unnecessary expenses and improve operational efficiencies. For more information, see [Design review checklist for Cost Optimization](/azure/well-architected/cost-optimization/checklist).
82+
83+
<!--
84+
Explain Cost Optimization considerations.
85+
Link to the pricing calculator (https://azure.microsoft.com/pricing/calculator), with this architecture prepopulated.
86+
Include the major cost-driving components, a typical scale or throughput, and recommended SKUs.
87+
-->
88+
89+
### Operational Excellence
90+
91+
<!--REQUIRED STATEMENT: Include the following statement to introduce the section:-->
92+
93+
Operational Excellence covers the operations processes that deploy an application and keep it running in production. For more information, see [Design review checklist for Operational Excellence](/azure/well-architected/operational-excellence/checklist).
94+
95+
<!-- Explain Operational Excellence considerations. -->
96+
97+
### Performance Efficiency
98+
99+
<!--REQUIRED STATEMENT: Include the following statement to introduce the section:-->
100+
101+
Performance Efficiency refers to your workload's ability to scale to meet user demands efficiently. For more information, see [Design review checklist for Performance Efficiency](/azure/well-architected/performance-efficiency/checklist).
102+
103+
<!-- Explain key performance considerations, beyond the typical. -->
104+
105+
## Deploy this scenario
106+
107+
<!--
108+
This section is required.
109+
Link to a GitHub-hosted template or script that explains how to deploy the solution.
110+
The repo will contain all of the source code, deployment code, and instructions for how to try the scenario in the customer's own subscription.
111+
-->
112+
113+
## Contributors
114+
115+
<!-- This section is expected but optional if the contributors prefer to omit it. -->
116+
117+
*Microsoft maintains this article. The following contributors wrote this article.*
118+
119+
Principal authors:
120+
121+
<!-- List the primary authors alphabetically by last name. -->
122+
123+
- [Author 1 Name](https://www.linkedin.com/in/ProfileURL/) | Title, such as "Cloud Solution Architect"
124+
- [Author 2 Name](https://www.linkedin.com/in/ProfileURL/) | Title, such as "Cloud Solution Architect"
125+
126+
Other contributors:
127+
128+
<!--
129+
- This section is optional.
130+
- List contributors and technical reviewers.
131+
-->
132+
133+
- [Contributor 1 Name](https://www.linkedin.com/in/ProfileURL/) | Title, such as "Cloud Solution Architect"
134+
- [Contributor 2 Name](https://www.linkedin.com/in/ProfileURL/) | Title, such as "Cloud Solution Architect"
135+
136+
*To see nonpublic LinkedIn profiles, sign in to LinkedIn.*
137+
138+
## Next steps
139+
140+
<!--
141+
- Add a bulleted list of links to third-party or Microsoft topics that can help customers build the workload.
142+
- Link formats:
143+
- Make Learn links site relative (for example, /azure/<feature>/<article-name>).
144+
- Start third-party links with `https://` and omit `en-us` unless the links don't work without it.
145+
- Omit a trailing slash, unless that is how the final URL renders after redirects.
146+
-->
147+
148+
## Related resources
149+
150+
<!-- Add a bulleted list of links to related architecture information in the AAC TOC. -->

0 commit comments

Comments
 (0)