Skip to content

Commit a91aa7f

Browse files
chore(repo): sync from inner source
Sync from github/github-well-architected-internal (main) Source Repository: github/github-well-architected-internal Source Branch: main Source SHA: ea7fb1f61daf4b556f92335bc2cdd3a86ffa6e14 Co-authored-by: well-architected-sync-bot[bot] <235114805+well-architected-sync-bot[bot]@users.noreply.github.com>
1 parent b592240 commit a91aa7f

2 files changed

Lines changed: 71 additions & 23 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,14 @@ flowchart LR
6666
F --> H[[Step 7<br />GitHub Review]]
6767
H --> I[Step 8<br />Publish]
6868
69-
style A fill:pink
70-
style B fill:pink
71-
style C fill:pink
72-
style D fill:pink
73-
style E fill:yellow
74-
style F fill:pink
75-
style H fill:silver
76-
style I fill:yellow
69+
style A fill:pink,color:#000
70+
style B fill:pink,color:#000
71+
style C fill:pink,color:#000
72+
style D fill:pink,color:#000
73+
style E fill:yellow,color:#000
74+
style F fill:pink,color:#000
75+
style H fill:silver,color:#000
76+
style I fill:yellow,color:#000
7777
```
7878

7979
**Legend:**
@@ -342,19 +342,18 @@ There are several primary types of contributions to this project:
342342

343343
### 📝 Content Library Article Submission(s)
344344

345-
Contributions will typically author content articles. To start writing, we recommend review these essential framework resources:
345+
Contributions will typically author content articles under `/content/` folder. To start writing, we recommend reviewing these essential framework resources:
346346

347347
- [Framework Overview] - Learn about the WAF mission, vision, objectives, and five pillars
348-
- [Project Structure](/docs/project-structure.md) - Understand the repository layout and where content lives
349348
- [Taxonomies](/docs/taxonomies.md) - Explore the design principles, areas, and other classifications
350349

351350
**Inspiration for Content Library articles** comes from **Azure Architecture Center**. See the following example articles for your inspiration: 💡
352351

353-
- [📄 Reliability: Recommendations for designing for redundancy](https://learn.microsoft.com/en-us/azure/well-architected/reliability/redundancy)
354-
- [📄 Security: Recommendations for identity and access management](https://learn.microsoft.com/en-us/azure/well-architected/security/identity-access)
355-
- [📄 Cost Optimization: Recommendations for optimizing environment costs](https://learn.microsoft.com/en-us/azure/well-architected/cost-optimization/optimize-environment-costs)
356-
- [📄 Operational Excellence: Recommendations for using infrastructure as code](https://learn.microsoft.com/en-us/azure/well-architected/operational-excellence/infrastructure-as-code-design)
357-
- [📄 Performance Efficiency: Recommendations for capacity planning](https://learn.microsoft.com/en-us/azure/well-architected/performance-efficiency/capacity-planning)
352+
- [📄 Reliability: Recommendations for designing for redundancy][reliability-redundancy]
353+
- [📄 Security: Recommendations for identity and access management][security-identity-access]
354+
- [📄 Cost Optimization: Recommendations for optimizing environment costs][cost-optimize-environment]
355+
- [📄 Operational Excellence: Recommendations for using infrastructure as code][operational-iac]
356+
- [📄 Performance Efficiency: Recommendations for capacity planning][performance-capacity-planning]
358357

359358
### 💻 Website Code Changes
360359

@@ -412,6 +411,22 @@ See [Framework Overview] for details on each pillar.
412411
- Keep sentences **short and clear**
413412
- Avoid unnecessary jargon
414413
- Include practical examples
414+
- Prefer GitHub Docs links to **Enterprise Cloud**: `https://docs.github.com/en/enterprise-cloud@latest` (unless the guidance is specific to GitHub Enterprise Server)
415+
- Use Hugo shortcodes to keep articles consistent (see `archetypes/default.md`):
416+
- Further assistance: `{{% seeking-further-assistance-details %}}`
417+
- Related links: `{{% related-links-github-docs %}}`
418+
419+
### Callouts
420+
421+
Use Hextra callouts to highlight important information:
422+
423+
```md
424+
{{< callout type="info" >}}
425+
This is an informational note.
426+
{{< /callout >}}
427+
```
428+
429+
Use `type` for standard callouts (`info`, `warning`, `error`). For custom callouts, use `emoji`.
415430

416431
> [!IMPORTANT]
417432
> Remember: [GitHub Docs] is the primary source of truth. Our framework supplements documentation with design thinking and decision-making guidance.
@@ -483,3 +498,8 @@ By contributing, you agree that your contributions will be licensed under the [M
483498
[Framework Overview]: /docs/framework-overview.md
484499
[Create a content request Issue]: https://github.com/github/github-well-architected-internal/issues/new?template=request-content.yml
485500
[GitHub Docs]: https://docs.github.com
501+
[reliability-redundancy]: https://learn.microsoft.com/en-us/azure/well-architected/reliability/redundancy
502+
[security-identity-access]: https://learn.microsoft.com/en-us/azure/well-architected/security/identity-access
503+
[cost-optimize-environment]: https://learn.microsoft.com/en-us/azure/well-architected/cost-optimization/optimize-environment-costs
504+
[operational-iac]: https://learn.microsoft.com/en-us/azure/well-architected/operational-excellence/infrastructure-as-code-design
505+
[performance-capacity-planning]: https://learn.microsoft.com/en-us/azure/well-architected/performance-efficiency/capacity-planning

docs/taxonomies.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When creating a new Content Library article, include relevant taxonomies in the
1414
---
1515
title: 'Your Article Title'
1616
draft: false
17-
publishDate: 2024-12-05
17+
publishDate: 2025-12-05
1818

1919
params:
2020
author:
@@ -43,7 +43,7 @@ features:
4343

4444
components:
4545
- code-scanning
46-
- repository-rulesets
46+
- branch-rulesets
4747
---
4848
```
4949

@@ -65,10 +65,12 @@ pillars:
6565

6666
# The areas of the GitHub adoption journey. Inspiration taken from docs.github.com
6767
areas:
68+
- agent-and-extensions
6869
- ci-cd-and-devops
6970
- client-apps
7071
- collaborative-coding
7172
- community
73+
- context-engineering
7274
- developers
7375
- enterprise-and-teams
7476
- getting-started
@@ -78,13 +80,16 @@ areas:
7880
# Classifications of industries who may be at different stages of the customer journey.
7981
verticals:
8082
- automotive
81-
- manufacturing
8283
- finance
8384
- gaming
84-
- media
8585
- government
8686
- information-technology
87+
- manufacturing
88+
- media
89+
- professional-service
90+
- retail
8791
- smb-corporate
92+
- mid-market
8893

8994
# Individuals in key roles on the customer journey, typically consisting of one or more administrators and the end-user community.
9095
personas:
@@ -105,43 +110,65 @@ platform:
105110
features:
106111
- codespaces
107112
- copilot
113+
- copilot-cli
108114
- git
109-
- github-advanced-security
110115
- github-actions
116+
- github-advanced-security
117+
- github-apps
111118
- github-cli
119+
- github-desktop
120+
- github-discussions
112121
- github-mobile
122+
- github-marketplace
113123
- github-pages
124+
- github-packages
114125
- github-projects
126+
- github-releases
115127
- issues-and-pull-requests
116-
- mcp
117128
- repositories
118129

119130
# Deeper-level topics of the GitHub Platform and its features. They are most often interacted with by end-users.
120131
components:
121132
- audit-log
122133
- actions-oidc
134+
- actions-runners
123135
- billing-and-cost-centers
136+
- branch-rulesets
137+
- caches-and-artifacts
138+
- chatmode
124139
- coding-agents
125140
- code-review-automation
126141
- code-scanning
142+
- context-engineering
127143
- copilot-autofix
128-
- copilot-enterprise
129144
- copilot-business
130145
- copilot-chat
146+
- copilot-enterprise
147+
- copilot-spaces
148+
- custom-instructions
131149
- dependabot-and-dependency-review
150+
- deployment-and-environments
132151
- git-lfs
133152
- governance-and-policy
153+
- graph-api
134154
- insights-and-metrics
135155
- limits
156+
- mcp-and-extensions
157+
- migration
136158
- performance-engineering
159+
- prompt-engineering
137160
- push-rulesets
138161
- repository-custom-properties
139-
- repository-rulesets
162+
- repository-rulesets # to be deprecated
163+
- rest-api
164+
- review-agents
165+
- secret-protection
140166
- secret-scanning
141167
- security-campaigns
142168
- security-configurations
143169
- sso-saml
144170
- sso-oidc
171+
- webhooks
145172

146173
# Associated teams and other GitHub and Partner resources that can provide additional support.
147174
github:
@@ -153,6 +180,7 @@ github:
153180
- enterprise-support
154181
- expert-services
155182
- fast-track
183+
- microsoft
156184
- partners
157185
- product-marketing
158186
```

0 commit comments

Comments
 (0)