Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"plugins": ["prettier-plugin-go-template"],
"overrides": [
{
"files": ["*.html"],
"options": {
"parser": "go-template"
}
}
],
"tabWidth": 2,
"useTabs": false,
"semi": true,
"singleQuote": false,
"trailingComma": "es5",
"printWidth": 100
}
73 changes: 49 additions & 24 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,107 @@
---
draft: true # Set to false when ready to publish
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"},
]

# 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

- placeholder
- placeholder

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

areas:
- placeholder
- placeholder

- placeholder
- placeholder

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

verticals:
- placeholder
- placeholder

- 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

- placeholder
- placeholder

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

platform:
- placeholder
- placeholder

- placeholder
- placeholder

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

features:
- placeholder
- placeholder

- placeholder
- placeholder

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

components:
- placeholder
- placeholder

- placeholder
- placeholder

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

github:
- placeholder
- placeholder

- 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-internal/blob/main/CONTRIBUTING.md
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.
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 %}}
Expand Down
2 changes: 2 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
description: The GitHub Well-Architected Framework is an open source-style, community-driven framework to curate the best way to deploy the GitHub platform.
params:
logosBlock: false
Expand Down
2 changes: 2 additions & 0 deletions content/library/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Content Library
cascade: # Automatically apply these for all children unless overridden
type: docs # Automatically set docs layout for all children: https://imfing.github.io/hextra/docs/guide/organize-files/#layouts
Expand Down
2 changes: 2 additions & 0 deletions content/library/application-security/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: 🔒 Application Security
weight: 5
slug: application-security
Expand Down
2 changes: 2 additions & 0 deletions content/library/application-security/checklist.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Checklist for Application Security
weight: 3
prev: library/application-security/design-principles
Expand Down
2 changes: 2 additions & 0 deletions content/library/application-security/design-principles.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Design Principles
weight: 2
prev: library/application-security/quick-links
Expand Down
2 changes: 2 additions & 0 deletions content/library/application-security/quick-links.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Quick links
weight: 1
prev: library/application-security
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Recommendations
weight: 5
prev: library/application-security
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Securing GitHub Actions Workflows'
publishDate: 2024-08-16
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Enforce GitHub Advanced Security at Scale'
publishDate: 2024-07-03
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Prioritizing Security Alert Remediation'
publishDate: 2025-08-05
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false
title: 'GitHub Repositories Threat Model'
publishDate: 2024-05-29
Expand Down Expand Up @@ -77,6 +79,8 @@ various ways a threat actor could gain access to a GitHub repository.

![Supply Chain](image1.png)

*Figure attribution: This diagram is derived from the [SLSA Supply Chain Threats model](https://slsa.dev/spec/v1.0/threats), version 1.0, from the [SLSA Framework](https://github.com/slsa-framework/slsa). Licensed under [Community Specification License 1.0](https://github.com/slsa-framework/slsa/blob/main/LICENSE.md).*

## System analysis

GitHub has the role of a multifaceted platform acting not only as the
Expand Down
2 changes: 2 additions & 0 deletions content/library/architecture/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: 📐 Architecture
weight: 7
slug: architecture
Expand Down
2 changes: 2 additions & 0 deletions content/library/architecture/checklist.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Checklist for Architecture
weight: 3
prev: library/architecture/design-principles
Expand Down
2 changes: 2 additions & 0 deletions content/library/architecture/design-principles.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Design Principles
weight: 2
prev: library/architecture/quick-links
Expand Down
2 changes: 2 additions & 0 deletions content/library/architecture/quick-links.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Quick links
weight: 1
prev: library/architecture
Expand Down
2 changes: 2 additions & 0 deletions content/library/architecture/recommendations/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Recommendations
weight: 5
prev: library/architecture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: "Accessing private networks from GitHub Actions Runners"
publishDate: 2024-09-09
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Scaling Git repositories'
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Managing large Git Repositories'
publishDate: 2024-09-03
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Exploring repository architecture strategy'
publishDate: 2024-09-03
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'When to use Git LFS'
publishDate: 2024-09-03
Expand Down
2 changes: 2 additions & 0 deletions content/library/collaboration/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: 👥 Collaboration
weight: 4
slug: collaboration
Expand Down
2 changes: 2 additions & 0 deletions content/library/collaboration/checklist.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Checklist for Collaboration
weight: 3
prev: library/collaboration/design-principles
Expand Down
2 changes: 2 additions & 0 deletions content/library/collaboration/design-principles.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Design Principles
weight: 2
prev: library/collaboration/quick-links
Expand Down
2 changes: 2 additions & 0 deletions content/library/collaboration/quick-links.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Quick links
weight: 1
prev: library/collaboration
Expand Down
2 changes: 2 additions & 0 deletions content/library/collaboration/recommendations/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Recommendations
weight: 5
prev: library/collaboration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Applying DevOps methodology'
publishDate: 2024-07-31
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false # Set to false when ready to publish
title: 'Champion Program'
publishDate: 2025-09-15
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
draft: false
title: 'Scaling GitHub Actions Reusability in the Enterprise'
publishDate: 2025-04-10
Expand Down
2 changes: 2 additions & 0 deletions content/library/governance/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: 📜 Governance
weight: 6
slug: governance
Expand Down
2 changes: 2 additions & 0 deletions content/library/governance/checklist.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Checklist for Governance
weight: 3
prev: library/governance/design-principles
Expand Down
2 changes: 2 additions & 0 deletions content/library/governance/design-principles.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Design Principles
weight: 2
prev: library/governance/quick-links
Expand Down
2 changes: 2 additions & 0 deletions content/library/governance/quick-links.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Quick links
weight: 1
prev: library/governance
Expand Down
2 changes: 2 additions & 0 deletions content/library/governance/recommendations/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# SPDX-FileCopyrightText: GitHub and The Project Authors
# SPDX-License-Identifier: MIT
title: Recommendations
weight: 5
prev: library/governance
Expand Down
Loading
Loading