Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Adds new page asking for help on identifiers #5354

Merged
merged 3 commits into from
Jul 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ permalink: /contribute
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [<img class="emoji" title=":octocat:" alt=":octocat:" src="https://github.githubassets.com/images/icons/emoji/octocat.png" width="20" height="20"> Hacktoberfest](#octocat-hacktoberfest)
- [<img class="emoji" title=":octocat:" alt=":octocat:" src="https://github.githubassets.com/images/icons/emoji/octocat.png" width="20" height="20"> 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)

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -463,6 +465,11 @@ docker run --rm \
# CTRL+C to exit and kill the instance
```

## 🆔 Adding Identifiers

We need help with adding more identifiers. Please see [this page](/help/identifiers-needed/) 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.
Expand Down
69 changes: 69 additions & 0 deletions pages/help/identifiers-needed.md
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>