From 6dec47a860752a563f382f02a6fef94c9cec75c0 Mon Sep 17 00:00:00 2001 From: Nemo Date: Wed, 26 Jun 2024 10:51:26 +0530 Subject: [PATCH 1/3] docs: Adds new page asking for help on identifiers --- CONTRIBUTING.md | 8 ++++- pages/identifiers-needed.md | 69 +++++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 pages/identifiers-needed.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de3421989ef..683e1e5ce5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,11 +10,12 @@ permalink: /contribute **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [:octocat: Hacktoberfest](#octocat-hacktoberfest) +- [:octocat: Hacktoberfest](#img-classemoji-titleoctocat-altoctocat-srchttpsgithubgithubassetscomimagesiconsemojioctocatpng-width20-height20-hacktoberfest) - [🕐 What's this project?](#-whats-this-project) - [:pencil: About the codebase](#pencil-about-the-codebase) - [:new: Adding a new product](#new-adding-a-new-product) - [✅ Validating your changes](#-validating-your-changes) +- [🆔 Adding Identifiers](#-adding-identifiers) - [📑 Suggested Reading](#-suggested-reading) - [:bookmark: Code of Conduct](#bookmark-code-of-conduct) @@ -276,6 +277,7 @@ auto: # A list of identifiers that can be used to detect this product as being used, # especially by SBOM tooling +# Please see https://endoflife.date/help/identifiers-needed/ for more information identifiers: # Each identifier is a way of linking this product to various methods of installing it @@ -463,6 +465,10 @@ docker run --rm \ # CTRL+C to exit and kill the instance ``` +## [🆔 Adding Identifiers](https://endoflife.date/help/identifiers-needed/) + +We need help with adding more identifiers. Please see for a list of pages missing identifiers. + ## 📑 Suggested Reading We have the following documents which should help you get familiar with the project and the codebase. You don't need to read all of these, and we've linked these docs above in cases where you must read any of them. diff --git a/pages/identifiers-needed.md b/pages/identifiers-needed.md new file mode 100644 index 00000000000..e1225f6f172 --- /dev/null +++ b/pages/identifiers-needed.md @@ -0,0 +1,69 @@ +--- +layout: default +nav_exclude: true +title: "Help: Identifiers Needed" +description: Help add more identifiers to the site +permalink: /help/identifiers-needed/ +--- + +endoflife.date maintains machine-readable identififers for various products to help the SBOM +ecosystem and other projects. We need your help to add more identifiers to the site. + +## What are Identifiers? + +We currently use the following identififers: + +1. [Repology](https://repology.org) Project Identififers. We use these to link to various package repositories and distributions. +2. [PURL](https://purl.org) Identififers. We use these to link to packages that are not present in Repology, such as Docker Images, Third-party linux repos, and more. +3. [NVD CPE](https://nvd.nist.gov/products/cpe) Identififers. Primarily used where repology/purl does not work, such as on devices and operating-systems. + +## How can you help + +For any of the pages below, click the edit link, and add a new field in the YAML called `identifiers`. Here's some sample identifiers that +we use across our various pages: + + +```yaml +identifiers: +# links the product to the https://repology.org/project/package-name/information +- repology: package-name +# See the PURL spec https://github.com/package-url/purl-spec +# for details, and avoid packages that are already mentioned on +# the repology page +# Common examples would be to use +# - pkg:os to document operating systems (https://github.com/package-url/purl-spec/pull/161) +# - pkg:github to link to GitHub pages +# - pkg:golang/pypi/gem/maven/npm etc for common package managers +# - pkg:docker for linking to docker images on Docker Hub +- purl: pkg:package-manager/package-name + +# A few sample PURLS from our various products + +- purl: pkg:docker/library/amazonlinux +- purl: pkg:apk/alpine/sqlite +- purl: pkg:oci/csi-node-driver-registrar?repository_url=k8s.gcr.io/sig-storage +- purl: pkg:github/kubernetes-csi/node-driver-registrar +- purl: pkg:golang/github.com/kubernetes-csi/node-driver-registrar +- purl: pkg:generic/firefox +- purl: pkg:maven/org.apache.zookeeper/zookeeper +- purl: pkg:oci/etcd?repository_url=quay.io/repository/coreos +- purl: pkg:brew/liberica-jdk17 +- purl: pkg:scoop/liberica17 +- purl: pkg:chocolatey/libericajdk +- purl: pkg:winget/BellSoft.LibericaJDK.8 +``` +## Pages without Identififers + + From 7d056cd10ecd7848b461bf8bab5fe7cdc3330833 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Sun, 28 Jul 2024 13:20:35 +0200 Subject: [PATCH 2/3] move page --- pages/{ => help}/identifiers-needed.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pages/{ => help}/identifiers-needed.md (100%) diff --git a/pages/identifiers-needed.md b/pages/help/identifiers-needed.md similarity index 100% rename from pages/identifiers-needed.md rename to pages/help/identifiers-needed.md From 9f232ac29d78d138c7745d4d9f360a77a765da38 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Sun, 28 Jul 2024 13:23:51 +0200 Subject: [PATCH 3/3] fix-link --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 683e1e5ce5a..c11152f073a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -465,9 +465,10 @@ docker run --rm \ # CTRL+C to exit and kill the instance ``` -## [🆔 Adding Identifiers](https://endoflife.date/help/identifiers-needed/) +## 🆔 Adding Identifiers -We need help with adding more identifiers. Please see for a list of pages missing identifiers. +We need help with adding more identifiers. Please see [this page](/help/identifiers-needed/) for a list of pages missing +identifiers. ## 📑 Suggested Reading