github-well-architected/archetypes/default.md at main · github/github-well-architected · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---
draft: true # Set to false when ready to publish
title: 'Insert title here'
publishDate: YYYY-MM-DD
params:

# Add and remove authors as needed. Please reserve authorship for significant contributions, not edits and feedback.

authors: [
{name: "INSERT_NAME_1", handle: "INSERT_HANDLE_1"},
{name: "INSERT_NAME_2", handle: "INSERT_HANDLE_2"},
]

# Classifications of the framework to drive key concepts, design principles, and architectural best practices

pillars:

- placeholder
- placeholder

# The areas of the GitHub adoption journey. Inspiration taken from docs.github.com

areas:

- placeholder
- placeholder

# Classifications of industries who may be at different stages of the customer journey.

verticals:

- placeholder
- placeholder

# Individuals in key roles on the customer journey, typically consisting of one or more administrators and the end-user community.

personas:

- placeholder
- placeholder

# Deployment options for GitHub Enterprise, including Cloud (GHEC), Server (GHES), and Hybrid.

platform:

- placeholder
- placeholder

# GitHub product functions designed to support every stage of development.

features:

- placeholder
- placeholder

# Deeper-level topics of the GitHub Platform and its features. They are most often interacted with by end-users.

components:

- placeholder
- placeholder

# Associated teams and other GitHub and Partner resources that can provide additional support.

github:

- placeholder
- placeholder

---

<!-- This disables the linting rule for multiple top-level headers -->
<!-- markdownlint-disable MD025 -->

<!--
See our CONTRIBUTING doc for submission details and additional writing style guidelines: https://github.com/github/github-well-architected/blob/main/CONTRIBUTING.md
-->

## Scenario overview

<!-- Provide a brief overview of the scenario that your article will cover. Be as generic, yet opinionated, as possible. -->

## Key design strategies and checklist

<!-- This section should discuss the key design strategies that your proposed solution employs. This could include architectural patterns, coding practices,
and other strategic decisions that were made during the design of the solution.

The checklist should provide a list of key steps or considerations that should be followed when implementing the solution. This could include things like
"Ensure all code is properly commented", "Write tests for all new functionality", "Verify the associated teams and resources", etc. -->

## Assumptions and preconditions

<!-- List any assumptions or preconditions that your article is based on. Be as generic, yet opinionated, as possible. -->

## Recommended deployment

<!-- Describe the recommended GitHub Platform deployment that your article will propose. This will typically zoom in on GitHub Platform products, features, and technologies you would prescribe. -->

## Additional solution detail and trade-offs to consider

<!-- Write more detail about the solution and articulate opinionated prescriptions, trade-offs, or consequences of either the deployment, the assumptions, or the desired goals. Be as generic, yet opinionated, as possible. -->

## Seeking further assistance

<!-- The Hugo shortcode below will fully populate this section -->

{{% seeking-further-assistance-details %}}

## Related links

<!-- The Hugo shortcode below will include a subsection that links to GitHub's documentation. -->

{{% related-links-github-docs %}}

<!-- ### External Resources -->

<!-- Optionally add any external resources that are related to your article or that could provide additional information or context for your readers.
This could include links to tutorials, blog posts, or other articles. -->