diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..ffe1a00 --- /dev/null +++ b/.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 +} \ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md index 4714807..abefaa6 100644 --- a/archetypes/default.md +++ b/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 + --- ## Scenario overview + ## Key design strategies and checklist + ## Assumptions and preconditions + ## Recommended deployment + ## Additional solution detail and trade-offs to consider + ## Seeking further assistance + {{% seeking-further-assistance-details %}} diff --git a/content/_index.md b/content/_index.md index a32db52..9fd4a58 100644 --- a/content/_index.md +++ b/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 diff --git a/content/library/_index.md b/content/library/_index.md index 4f35761..1302339 100644 --- a/content/library/_index.md +++ b/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 diff --git a/content/library/application-security/_index.md b/content/library/application-security/_index.md index 8e5d2c4..55ff9f8 100644 --- a/content/library/application-security/_index.md +++ b/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 diff --git a/content/library/application-security/checklist.md b/content/library/application-security/checklist.md index c6a3391..101e9fe 100644 --- a/content/library/application-security/checklist.md +++ b/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 diff --git a/content/library/application-security/design-principles.md b/content/library/application-security/design-principles.md index 7e7c94a..ff0283d 100644 --- a/content/library/application-security/design-principles.md +++ b/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 diff --git a/content/library/application-security/quick-links.md b/content/library/application-security/quick-links.md index 8cbd37c..d16d4e2 100644 --- a/content/library/application-security/quick-links.md +++ b/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 diff --git a/content/library/application-security/recommendations/_index.md b/content/library/application-security/recommendations/_index.md index c14ea70..4b8c454 100644 --- a/content/library/application-security/recommendations/_index.md +++ b/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 diff --git a/content/library/application-security/recommendations/actions-security/index.md b/content/library/application-security/recommendations/actions-security/index.md index e4559a5..0040e99 100644 --- a/content/library/application-security/recommendations/actions-security/index.md +++ b/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 diff --git a/content/library/application-security/recommendations/enforce-ghas-at-scale/index.md b/content/library/application-security/recommendations/enforce-ghas-at-scale/index.md index cffad61..d4aa38e 100644 --- a/content/library/application-security/recommendations/enforce-ghas-at-scale/index.md +++ b/content/library/application-security/recommendations/enforce-ghas-at-scale/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: 'Enforce GitHub Advanced Security at Scale' publishDate: 2024-07-03 diff --git a/content/library/application-security/recommendations/prioritizing-alerts/index.md b/content/library/application-security/recommendations/prioritizing-alerts/index.md index 2a5851f..89cfa98 100644 --- a/content/library/application-security/recommendations/prioritizing-alerts/index.md +++ b/content/library/application-security/recommendations/prioritizing-alerts/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: 'Prioritizing Security Alert Remediation' publishDate: 2025-08-05 diff --git a/content/library/application-security/recommendations/threat-model/index.md b/content/library/application-security/recommendations/threat-model/index.md index 5f83a5c..526ae7d 100644 --- a/content/library/application-security/recommendations/threat-model/index.md +++ b/content/library/application-security/recommendations/threat-model/index.md @@ -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 @@ -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 diff --git a/content/library/architecture/_index.md b/content/library/architecture/_index.md index 3d40030..0b0c264 100644 --- a/content/library/architecture/_index.md +++ b/content/library/architecture/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: 📐 Architecture weight: 7 slug: architecture diff --git a/content/library/architecture/checklist.md b/content/library/architecture/checklist.md index 5cfc3a4..433439d 100644 --- a/content/library/architecture/checklist.md +++ b/content/library/architecture/checklist.md @@ -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 diff --git a/content/library/architecture/design-principles.md b/content/library/architecture/design-principles.md index e743202..ae44fd3 100644 --- a/content/library/architecture/design-principles.md +++ b/content/library/architecture/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/architecture/quick-links diff --git a/content/library/architecture/quick-links.md b/content/library/architecture/quick-links.md index 5a42460..7f94cf6 100644 --- a/content/library/architecture/quick-links.md +++ b/content/library/architecture/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/architecture diff --git a/content/library/architecture/recommendations/_index.md b/content/library/architecture/recommendations/_index.md index 8fe53eb..dc44fde 100644 --- a/content/library/architecture/recommendations/_index.md +++ b/content/library/architecture/recommendations/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Recommendations weight: 5 prev: library/architecture diff --git a/content/library/architecture/recommendations/hosted-runner-private-networking/index.md b/content/library/architecture/recommendations/hosted-runner-private-networking/index.md index c03a331..32cef6f 100644 --- a/content/library/architecture/recommendations/hosted-runner-private-networking/index.md +++ b/content/library/architecture/recommendations/hosted-runner-private-networking/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: "Accessing private networks from GitHub Actions Runners" publishDate: 2024-09-09 diff --git a/content/library/architecture/recommendations/scaling-git-repositories/_index.md b/content/library/architecture/recommendations/scaling-git-repositories/_index.md index ad0a77d..8b61561 100644 --- a/content/library/architecture/recommendations/scaling-git-repositories/_index.md +++ b/content/library/architecture/recommendations/scaling-git-repositories/_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: 'Scaling Git repositories' --- diff --git a/content/library/architecture/recommendations/scaling-git-repositories/large-git-repositories.md b/content/library/architecture/recommendations/scaling-git-repositories/large-git-repositories.md index 7e741e2..aeba3b7 100644 --- a/content/library/architecture/recommendations/scaling-git-repositories/large-git-repositories.md +++ b/content/library/architecture/recommendations/scaling-git-repositories/large-git-repositories.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: 'Managing large Git Repositories' publishDate: 2024-09-03 diff --git a/content/library/architecture/recommendations/scaling-git-repositories/repository-architecture-strategy.md b/content/library/architecture/recommendations/scaling-git-repositories/repository-architecture-strategy.md index 0b171fb..3012fb6 100644 --- a/content/library/architecture/recommendations/scaling-git-repositories/repository-architecture-strategy.md +++ b/content/library/architecture/recommendations/scaling-git-repositories/repository-architecture-strategy.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: 'Exploring repository architecture strategy' publishDate: 2024-09-03 diff --git a/content/library/architecture/recommendations/scaling-git-repositories/when-to-use-git-lfs.md b/content/library/architecture/recommendations/scaling-git-repositories/when-to-use-git-lfs.md index 6298492..d8e3cb7 100644 --- a/content/library/architecture/recommendations/scaling-git-repositories/when-to-use-git-lfs.md +++ b/content/library/architecture/recommendations/scaling-git-repositories/when-to-use-git-lfs.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: 'When to use Git LFS' publishDate: 2024-09-03 diff --git a/content/library/collaboration/_index.md b/content/library/collaboration/_index.md index 054e953..04f94a6 100644 --- a/content/library/collaboration/_index.md +++ b/content/library/collaboration/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: 👥 Collaboration weight: 4 slug: collaboration diff --git a/content/library/collaboration/checklist.md b/content/library/collaboration/checklist.md index 427568e..930b60a 100644 --- a/content/library/collaboration/checklist.md +++ b/content/library/collaboration/checklist.md @@ -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 diff --git a/content/library/collaboration/design-principles.md b/content/library/collaboration/design-principles.md index c18c711..bd9cbdb 100644 --- a/content/library/collaboration/design-principles.md +++ b/content/library/collaboration/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/collaboration/quick-links diff --git a/content/library/collaboration/quick-links.md b/content/library/collaboration/quick-links.md index af74ff4..00c5e9a 100644 --- a/content/library/collaboration/quick-links.md +++ b/content/library/collaboration/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/collaboration diff --git a/content/library/collaboration/recommendations/_index.md b/content/library/collaboration/recommendations/_index.md index 5f386ef..c175275 100644 --- a/content/library/collaboration/recommendations/_index.md +++ b/content/library/collaboration/recommendations/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Recommendations weight: 5 prev: library/collaboration diff --git a/content/library/collaboration/recommendations/applying-devops-methodology.md b/content/library/collaboration/recommendations/applying-devops-methodology.md index 60168ea..f999702 100644 --- a/content/library/collaboration/recommendations/applying-devops-methodology.md +++ b/content/library/collaboration/recommendations/applying-devops-methodology.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: 'Applying DevOps methodology' publishDate: 2024-07-31 diff --git a/content/library/collaboration/recommendations/champion-program/index.md b/content/library/collaboration/recommendations/champion-program/index.md index bd6dc88..b0fd7b6 100644 --- a/content/library/collaboration/recommendations/champion-program/index.md +++ b/content/library/collaboration/recommendations/champion-program/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: 'Champion Program' publishDate: 2025-09-15 diff --git a/content/library/collaboration/recommendations/scaling-actions-reusability/index.md b/content/library/collaboration/recommendations/scaling-actions-reusability/index.md index efca9af..0a67f6e 100644 --- a/content/library/collaboration/recommendations/scaling-actions-reusability/index.md +++ b/content/library/collaboration/recommendations/scaling-actions-reusability/index.md @@ -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 diff --git a/content/library/governance/_index.md b/content/library/governance/_index.md index 7c48b4a..4c7c816 100644 --- a/content/library/governance/_index.md +++ b/content/library/governance/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: 📜 Governance weight: 6 slug: governance diff --git a/content/library/governance/checklist.md b/content/library/governance/checklist.md index 6a68935..69da138 100644 --- a/content/library/governance/checklist.md +++ b/content/library/governance/checklist.md @@ -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 diff --git a/content/library/governance/design-principles.md b/content/library/governance/design-principles.md index ece398d..d6e4767 100644 --- a/content/library/governance/design-principles.md +++ b/content/library/governance/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/governance/quick-links diff --git a/content/library/governance/quick-links.md b/content/library/governance/quick-links.md index ee4256f..0143691 100644 --- a/content/library/governance/quick-links.md +++ b/content/library/governance/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/governance diff --git a/content/library/governance/recommendations/_index.md b/content/library/governance/recommendations/_index.md index 88a14f3..25b6f87 100644 --- a/content/library/governance/recommendations/_index.md +++ b/content/library/governance/recommendations/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Recommendations weight: 5 prev: library/governance diff --git a/content/library/governance/recommendations/copilot-policies-best-practices/copilot_pru_enterprise_admin_playbook.md b/content/library/governance/recommendations/copilot-policies-best-practices/copilot_pru_enterprise_admin_playbook.md index 80b80d7..4a34bb1 100644 --- a/content/library/governance/recommendations/copilot-policies-best-practices/copilot_pru_enterprise_admin_playbook.md +++ b/content/library/governance/recommendations/copilot-policies-best-practices/copilot_pru_enterprise_admin_playbook.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT draft: false title: 'Managing GitHub Copilot Premium Request Units (PRUs)' publishDate: 2025-08-26 diff --git a/content/library/governance/recommendations/governance-policies-best-practices/index.md b/content/library/governance/recommendations/governance-policies-best-practices/index.md index f07f18b..4d72b99 100644 --- a/content/library/governance/recommendations/governance-policies-best-practices/index.md +++ b/content/library/governance/recommendations/governance-policies-best-practices/index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT draft: false title: 'GitHub Enterprise Policies & Best Practices' publishDate: 2024-07-29 diff --git a/content/library/governance/recommendations/managing-repositories-at-scale/_index.md b/content/library/governance/recommendations/managing-repositories-at-scale/_index.md index 5615a40..1c4aff0 100644 --- a/content/library/governance/recommendations/managing-repositories-at-scale/_index.md +++ b/content/library/governance/recommendations/managing-repositories-at-scale/_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: 'Managing Repositories at Scale' --- diff --git a/content/library/governance/recommendations/managing-repositories-at-scale/custom-properties-best-practices.md b/content/library/governance/recommendations/managing-repositories-at-scale/custom-properties-best-practices.md index fb6dbe4..1d73b47 100644 --- a/content/library/governance/recommendations/managing-repositories-at-scale/custom-properties-best-practices.md +++ b/content/library/governance/recommendations/managing-repositories-at-scale/custom-properties-best-practices.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: 'Custom Properties Best Practices' publishDate: 2025-09-02 diff --git a/content/library/governance/recommendations/managing-repositories-at-scale/rulesets-best-practices.md b/content/library/governance/recommendations/managing-repositories-at-scale/rulesets-best-practices.md index 9123dd5..064c130 100644 --- a/content/library/governance/recommendations/managing-repositories-at-scale/rulesets-best-practices.md +++ b/content/library/governance/recommendations/managing-repositories-at-scale/rulesets-best-practices.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: 'Rulesets Best Practices' publishDate: 2024-10-08 diff --git a/content/library/overview/_index.md b/content/library/overview/_index.md index 8150e0e..123fd89 100644 --- a/content/library/overview/_index.md +++ b/content/library/overview/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Overview weight: 1 next: library/overview/layers diff --git a/content/library/overview/about-the-assessment.md b/content/library/overview/about-the-assessment.md index cbaa751..6be90e6 100644 --- a/content/library/overview/about-the-assessment.md +++ b/content/library/overview/about-the-assessment.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: About the Assessment weight: 2 prev: library/overview/layers diff --git a/content/library/overview/getting-started-checklist.md b/content/library/overview/getting-started-checklist.md index 1cb79e5..90c461f 100644 --- a/content/library/overview/getting-started-checklist.md +++ b/content/library/overview/getting-started-checklist.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Getting Started Checklist weight: 3 prev: library/overview/about-the-assessment diff --git a/content/library/overview/layers.md b/content/library/overview/layers.md index f8e3834..6e45d21 100644 --- a/content/library/overview/layers.md +++ b/content/library/overview/layers.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Layers of GitHub Well-Architected weight: 1 prev: library/overview diff --git a/content/library/overview/release-notes.md b/content/library/overview/release-notes.md index f823475..473a289 100644 --- a/content/library/overview/release-notes.md +++ b/content/library/overview/release-notes.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Release notes weight: 4 prev: library/overview/getting-started-checklist diff --git a/content/library/productivity/_index.md b/content/library/productivity/_index.md index 633861b..0109b16 100644 --- a/content/library/productivity/_index.md +++ b/content/library/productivity/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: ⚙️ Productivity weight: 3 slug: productivity diff --git a/content/library/productivity/checklist.md b/content/library/productivity/checklist.md index 025a828..8ab82f7 100644 --- a/content/library/productivity/checklist.md +++ b/content/library/productivity/checklist.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Checklist for Productivity weight: 3 prev: library/productivity/design-principles diff --git a/content/library/productivity/design-principles.md b/content/library/productivity/design-principles.md index 3bfecd7..af141d6 100644 --- a/content/library/productivity/design-principles.md +++ b/content/library/productivity/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/productivity/quick-links diff --git a/content/library/productivity/quick-links.md b/content/library/productivity/quick-links.md index 03aac60..8a1ceee 100644 --- a/content/library/productivity/quick-links.md +++ b/content/library/productivity/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/productivity/introduction diff --git a/content/library/productivity/recommendations/_index.md b/content/library/productivity/recommendations/_index.md index 19abee0..a715949 100644 --- a/content/library/productivity/recommendations/_index.md +++ b/content/library/productivity/recommendations/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Recommendations weight: 5 prev: library/productivity diff --git a/content/library/productivity/recommendations/adopting-copilot-at-scale/index.md b/content/library/productivity/recommendations/adopting-copilot-at-scale/index.md index 7b6bae1..5ad42b2 100644 --- a/content/library/productivity/recommendations/adopting-copilot-at-scale/index.md +++ b/content/library/productivity/recommendations/adopting-copilot-at-scale/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: 'Adopting GitHub Copilot at Scale' publishDate: 2024-07-22 diff --git a/content/library/productivity/recommendations/engineering-system-metrics.md b/content/library/productivity/recommendations/engineering-system-metrics.md index a4f4f1a..38d7f17 100644 --- a/content/library/productivity/recommendations/engineering-system-metrics.md +++ b/content/library/productivity/recommendations/engineering-system-metrics.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: 'Engineering System Metrics' publishDate: 2025-04-24 diff --git a/content/library/scenarios/_index.md b/content/library/scenarios/_index.md index b42dbad..9986839 100644 --- a/content/library/scenarios/_index.md +++ b/content/library/scenarios/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Scenarios weight: 2 slug: scenarios diff --git a/content/library/scenarios/anti-patterns.md b/content/library/scenarios/anti-patterns.md index 2fc0de2..404fa3c 100644 --- a/content/library/scenarios/anti-patterns.md +++ b/content/library/scenarios/anti-patterns.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Anti-patterns weight: 1 --- diff --git a/content/library/scenarios/measuring-genai-impact.md b/content/library/scenarios/measuring-genai-impact.md index c09dc2d..90d3361 100644 --- a/content/library/scenarios/measuring-genai-impact.md +++ b/content/library/scenarios/measuring-genai-impact.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Measuring Impact for GenAI Adoption weight: 3 publishDate: 2025-04-24 diff --git a/content/library/scenarios/migrations/_index.md b/content/library/scenarios/migrations/_index.md index afb3a7d..a620fda 100644 --- a/content/library/scenarios/migrations/_index.md +++ b/content/library/scenarios/migrations/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Migrations weight: 2 --- diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/01-project-planning.md b/content/library/scenarios/migrations/azure-devops-migration-guide/01-project-planning.md index ea9808a..24dfc3d 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/01-project-planning.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/01-project-planning.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Plan description: Project Planning Guide weight: 10 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/02-source-environment-assessment.md b/content/library/scenarios/migrations/azure-devops-migration-guide/02-source-environment-assessment.md index 928eb41..9b96472 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/02-source-environment-assessment.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/02-source-environment-assessment.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Assess description: Source Environment Assessment Guide weight: 11 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/03-target-environment.md b/content/library/scenarios/migrations/azure-devops-migration-guide/03-target-environment.md index 8ee2e50..e7a437c 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/03-target-environment.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/03-target-environment.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Setup description: Target Environment Setup Guide weight: 12 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/04-migration-testing.md b/content/library/scenarios/migrations/azure-devops-migration-guide/04-migration-testing.md index 80935d8..31a64d3 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/04-migration-testing.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/04-migration-testing.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Test description: Migration Testing Guide weight: 13 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/05-repository-migration.md b/content/library/scenarios/migrations/azure-devops-migration-guide/05-repository-migration.md index 27dbd61..b7e360e 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/05-repository-migration.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/05-repository-migration.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Migrate description: Repository Migration Guide weight: 14 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/06-post-migration.md b/content/library/scenarios/migrations/azure-devops-migration-guide/06-post-migration.md index 0d8c503..7c40a08 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/06-post-migration.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/06-post-migration.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Post-Migration description: Post-Migration Activities Guide weight: 15 diff --git a/content/library/scenarios/migrations/azure-devops-migration-guide/_index.md b/content/library/scenarios/migrations/azure-devops-migration-guide/_index.md index 37392de..477a301 100644 --- a/content/library/scenarios/migrations/azure-devops-migration-guide/_index.md +++ b/content/library/scenarios/migrations/azure-devops-migration-guide/_index.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Azure DevOps to GitHub Enterprise Migration Guide --- diff --git a/content/library/scenarios/migrations/repository-checklist.md b/content/library/scenarios/migrations/repository-checklist.md index 7b65ef9..3227ebe 100644 --- a/content/library/scenarios/migrations/repository-checklist.md +++ b/content/library/scenarios/migrations/repository-checklist.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Checklist for Repository Migrations description: A checklist to help you plan and execute a successful repository migration to GitHub. aliases: diff --git a/content/library/scenarios/monorepos.md b/content/library/scenarios/monorepos.md index c0c8e6f..9d0a210 100644 --- a/content/library/scenarios/monorepos.md +++ b/content/library/scenarios/monorepos.md @@ -1,4 +1,6 @@ --- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT title: Monorepos weight: 3 --- diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 7ea1350..2dde512 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -11,8 +11,7 @@ {{- if .IsHome -}} {{ .Site.Title -}} {{ else -}} - {{ with .Title }}{{ . }} – {{ end -}} - {{ .Site.Title -}} + {{ with .Title }}{{ . }} – {{ end -}} {{ .Site.Title -}} {{ end -}} @@ -22,7 +21,6 @@ {{ else }} {{ end }} - {{ partial "opengraph.html" . }} {{ template "_internal/schema.html" . -}} {{ template "_internal/twitter_cards.html" . -}} @@ -31,36 +29,36 @@ - {{- if and (eq hugo.Environment "production") (or .Site.Config.Services.GoogleAnalytics.ID .Site.Config.Services.GoogleAnalytics.ID) }} + {{- if and (eq hugo.Environment "production") .Site.Config.Services.GoogleAnalytics.ID }} {{ partial "google-analytics.html" . }} {{- end }} - - {{ partial "custom/head-end.html" . }}