Auto-merged by Well-Architected OSS Bot

Sync from github/github-well-architected-internal (main)

Source Repository: github/github-well-architected-internal

Source Branch: main

Source SHA: 5c67c52b7c7c81c5f0f54dcd7b0c5956f0d71173

Co-authored-by: well-architected-sync-bot[bot] <235114805+well-architected-sync-bot[bot]@users.noreply.github.com>

Author: well-architected-sync-bot[bot]

.prettierrc

@@ -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
+}

archetypes/default.md

@@ -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 %}}

content/_index.md

@@ -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

content/library/_index.md

@@ -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

content/library/application-security/_index.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: GitHub and The Project Authors
+# SPDX-License-Identifier: MIT
 title: 🔒 Application Security
 weight: 5
 slug: application-security

content/library/application-security/checklist.md

@@ -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

content/library/application-security/design-principles.md

@@ -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

content/library/application-security/quick-links.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: GitHub and The Project Authors
+# SPDX-License-Identifier: MIT
 title: Quick links
 weight: 1
 prev: library/application-security

content/library/application-security/recommendations/_index.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: GitHub and The Project Authors
+# SPDX-License-Identifier: MIT
 title: Recommendations
 weight: 5
 prev: library/application-security

content/library/application-security/recommendations/actions-security/index.md

@@ -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