forked from endoflife-date/endoflife.date
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add new page asking for help on identifiers (endoflife-date#5354)
Co-authored-by: Marc Wrobel <[email protected]>
- Loading branch information
1 parent
8f6f788
commit f157bdf
Showing
2 changed files
with
77 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<ul> | ||
{% for page in site.html_pages %} | ||
{% if page.layout == 'product' %} | ||
{% if page.identifiers.size == 0 %} | ||
<li> | ||
<a href="{{ page.url }}">{{ page.title }}</a> - <a href="{{page.url}}/_edit">Edit</a> | ||
</li> | ||
{% endif %} | ||
{% endif %} | ||
{% endfor %} | ||
</ul> |