From 00b9bd732fa7d90c3d0a6184b413ded1d9d588c7 Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Mon, 21 Oct 2024 08:48:03 +0100 Subject: [PATCH] Scannability improvements for front matter in Dependency graph articles (#52745) --- .../about-the-dependency-graph.md | 1 + .../configuring-the-dependency-graph.md | 1 + .../exploring-the-dependencies-of-a-repository.md | 1 + ...ftware-bill-of-materials-for-your-repository.md | 2 +- .../troubleshooting-the-dependency-graph.md | 1 + ...sights-for-dependencies-in-your-organization.md | 2 +- data/reusables/gated-features/dependency-graph.md | 14 ++++++++++++++ .../permissions/dependency-graph-export-sbom.md | 1 + .../dependency-graph-view-dependencies.md | 1 + .../dependency-graph-view-org-insights.md | 1 + data/reusables/permissions/dependency-graph.md | 9 +++++++++ 11 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 data/reusables/gated-features/dependency-graph.md create mode 100644 data/reusables/permissions/dependency-graph-export-sbom.md create mode 100644 data/reusables/permissions/dependency-graph-view-dependencies.md create mode 100644 data/reusables/permissions/dependency-graph-view-org-insights.md create mode 100644 data/reusables/permissions/dependency-graph.md diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 4a85e38f682a..9d874fe87dff 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md @@ -1,6 +1,7 @@ --- title: About the dependency graph intro: You can use the dependency graph to identify all your project's dependencies. The dependency graph supports a range of popular package ecosystems. +product: '{% data reusables.gated-features.dependency-graph %}' redirect_from: - /github/visualizing-repository-data-with-graphs/about-the-dependency-graph - /code-security/supply-chain-security/about-the-dependency-graph diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md index ccf59ff16136..07f11fdb02ee 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md @@ -1,6 +1,7 @@ --- title: Configuring the dependency graph intro: You can allow users to identify their projects' dependencies by enabling the dependency graph. +permissions: '{% data reusables.permissions.dependency-graph %}' redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph versions: diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index 1ecbbc3b70bd..ab3a0c75e9c3 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -1,6 +1,7 @@ --- title: Exploring the dependencies of a repository intro: 'You can use the dependency graph to see the packages your project depends on{% ifversion fpt or ghec %} and the repositories that depend on it{% endif %}. In addition, you can see any vulnerabilities detected in its dependencies.' +permissions: '{% data reusables.permissions.dependency-graph-view-dependencies %}' redirect_from: - /articles/listing-the-packages-that-a-repository-depends-on - /github/visualizing-repository-data-with-graphs/listing-the-packages-that-a-repository-depends-on diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md index 539319a8dc20..7d91ee87e57e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md @@ -5,7 +5,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -permissions: 'Anyone can export the dependency graph of a repository as a software bill of materials. The SBOM export will contain a list of the dependencies that are used in the repository.' +permissions: '{% data reusables.permissions.dependency-graph-export-sbom %}' type: how_to topics: - Dependency graph diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md index 764a428779d1..951aadd6ca7d 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md @@ -1,6 +1,7 @@ --- title: Troubleshooting the dependency graph intro: 'If the dependency information reported by the dependency graph is not what you expected, there are a number of points to consider, and various things you can check.' +product: '{% data reusables.gated-features.dependency-graph %}' shortTitle: Troubleshoot dependency graph versions: fpt: '*' diff --git a/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md index 3898ff90d2f4..a2e2c388b4c1 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md +++ b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md @@ -11,7 +11,7 @@ topics: - Organizations - Teams shortTitle: Dependency insights -permissions: Organization members can view organization insights. +permissions: '{% data reusables.permissions.dependency-graph-view-org-insights %}' --- {% note %} diff --git a/data/reusables/gated-features/dependency-graph.md b/data/reusables/gated-features/dependency-graph.md new file mode 100644 index 000000000000..dca9fe4b5353 --- /dev/null +++ b/data/reusables/gated-features/dependency-graph.md @@ -0,0 +1,14 @@ + +{% ifversion fpt or ghec %} + +The dependency graph is available for the following repository types: + +* Public repositories (on by default) +* Private repositories +* Forks + +{% elsif ghes %} + +The dependency graph is available for all repositories. + +{% endif %} diff --git a/data/reusables/permissions/dependency-graph-export-sbom.md b/data/reusables/permissions/dependency-graph-export-sbom.md new file mode 100644 index 000000000000..e5fbbcd423d7 --- /dev/null +++ b/data/reusables/permissions/dependency-graph-export-sbom.md @@ -0,0 +1 @@ +Anyone on {% data variables.product.company_short %} diff --git a/data/reusables/permissions/dependency-graph-view-dependencies.md b/data/reusables/permissions/dependency-graph-view-dependencies.md new file mode 100644 index 000000000000..02427f1b2e98 --- /dev/null +++ b/data/reusables/permissions/dependency-graph-view-dependencies.md @@ -0,0 +1 @@ +Repository administrators, organization owners, and people with **write** or **maintain** access to a repository diff --git a/data/reusables/permissions/dependency-graph-view-org-insights.md b/data/reusables/permissions/dependency-graph-view-org-insights.md new file mode 100644 index 000000000000..873b9418f515 --- /dev/null +++ b/data/reusables/permissions/dependency-graph-view-org-insights.md @@ -0,0 +1 @@ +Organization members diff --git a/data/reusables/permissions/dependency-graph.md b/data/reusables/permissions/dependency-graph.md new file mode 100644 index 000000000000..abab6ba543f0 --- /dev/null +++ b/data/reusables/permissions/dependency-graph.md @@ -0,0 +1,9 @@ +{% ifversion fpt or ghec %} + +Repository owners, organization owners, security managers, and users with the **admin** role + +{% elsif ghes %} + +Enteprise owners + +{% endif %}