Skip to content

Commit

Permalink
Tag products (#2225)
Browse files Browse the repository at this point in the history
Define rules for tags in CONTRIBUTING.md, and add tags (aka labels) to products.

This commit focus on a limited set of tags, meaning:

- tags to set a product family such as linux-distribution, web-browser, mobile-phone or web-server,
- tags to set a product vendor such as adobe, amazon or apache,
- tags to set a runtime dependency such as java-runtime, javascript-runtime or php-runtime.
  • Loading branch information
marcwrobel committed Jun 11, 2023
1 parent 65bf73c commit 6d9a994
Show file tree
Hide file tree
Showing 184 changed files with 358 additions and 154 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,23 @@ title: Timeturner
# - server-app is for applications usually installed on the server-side.
category: os

# Tags of the product (optional).
#
# Tags :
# - must match [a-z0-9\-]+,
# - must be declared with a space-separated string,
# - must be alphabetically ordered,
# - must use singular (for example web-server, not web-servers),
# - should be used at least twice,
# - must be added for one of the following reasons :
# - set a product family such as linux-distribution, web-browser, mobile-phone or web-server,
# - set a product vendor such as adobe, amazon or apache,
# - set a runtime dependency such as java-runtime, javascript-runtime or php-runtime.
#
# Remember that no tag is better than useless tag. Also note that categories are automatically tags, but don't
# use another category as a tag.
tags: amazon linux

# Simple Icons (https://simpleicons.org/) icon slug (optional).
# Remove this property if the icon is not available on Simple Icons.
# As an example, https://simpleicons.org/?q=codemagic links to https://simpleicons.org/icons/codemagic.svg ,
Expand Down
7 changes: 7 additions & 0 deletions _auto/validate.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import re

import sys
import frontmatter
from datetime import date
Expand Down Expand Up @@ -36,6 +38,8 @@ def load_product_data(file):
def assert_that_in(values, value, name, file):
assert value in values, f"{name} '{value}' is not valid in {file}, it must be in {values}"

def assert_that_match(regex, value, name, file):
assert bool(re.fullmatch(regex, value)), f"{name} '{value}' does not match {regex} in {file}"

def assert_not_blank(value, name, file):
assert value.strip(), f"{name} must not be blank in {file}"
Expand All @@ -57,6 +61,9 @@ def validate_product(file):
assert_that_in(VALID_CATEGORIES, data['category'], 'category', file)
assert_that_starts_with('/', data['permalink'], 'permalink', file)

if "tags" in data:
assert_that_match("^[a-z0-9\-]+( [a-z0-9\-]+)*", data['tags'], 'tags', file)

if "alternate_urls" in data:
for url in data["alternate_urls"]:
assert_that_starts_with('/', url, 'alternate_url', file)
Expand Down
2 changes: 1 addition & 1 deletion _plugins/product-data-enricher.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def set_tags(page)
end

tags << page.data['category']
page.data['tags'] = tags
page.data['tags'] = tags.sort
end

# Set properly the column presence/label if it was overridden.
Expand Down
1 change: 1 addition & 0 deletions products/alibaba-dragonwell.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Alibaba Dragonwell
category: lang
tags: alibaba java-distribution
iconSlug: openjdk
permalink: /alibaba-dragonwell

Expand Down
1 change: 1 addition & 0 deletions products/almalinux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AlmaLinux OS
category: os
tags: linux-distribution
permalink: /almalinux
versionCommand: cat /etc/redhat-release
releasePolicyLink: https://blog.cloudlinux.com/announcing-open-sourced-community-driven-rhel-fork-by-cloudlinux
Expand Down
1 change: 1 addition & 0 deletions products/alpinelinux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Alpine Linux
category: os
tags: linux-distribution
iconSlug: alpinelinux
permalink: /alpine
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/amazon-corretto.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Amazon Corretto
category: lang
tags: amazon java-distribution
iconSlug: openjdk
permalink: /amazon-corretto
alternate_urls:
Expand Down
5 changes: 3 additions & 2 deletions products/amazon-linux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Amazon Linux
category: os
tags: amazon linux-distribution
iconSlug: amazonaws
permalink: /amazon-linux
versionCommand: cat /etc/system-release
Expand Down Expand Up @@ -189,9 +190,9 @@ AWS announced [Amazon Linux 2023][al2023] [^1] as a successor to
Amazon Linux 2, which uses Fedora as the upstream. It reached
GA (General Availability) in March 2023.

Every major version release is supported by Standard Support for 2 years,
Every major version release is supported by Standard Support for 2 years,
followed by a maintenance phase of 3 years. Quarterly minor releases will be made
during the Standard Support phase and include security updates,
during the Standard Support phase and include security updates,
bug fixes, and new features and packages. Minor releases do not
break backward-compatibility.

Expand Down
1 change: 1 addition & 0 deletions products/amazon-rds-mysql.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Amazon RDS for MySQL
category: service
tags: amazon managed-mysql
iconSlug: amazonaws
permalink: /amazon-rds-mysql
releasePolicyLink: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Concepts.VersionMgmt.html
Expand Down
1 change: 1 addition & 0 deletions products/amazon-rds-postgresql.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Amazon RDS for PostgreSQL
category: service
tags: amazon managed-postgresql
iconSlug: amazonaws
permalink: /amazon-rds-postgresql
releasePolicyLink: https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-release-calendar.html
Expand Down
1 change: 1 addition & 0 deletions products/android.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Android OS
category: os
tags: google
iconSlug: android
permalink: /android
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/angular.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Angular
category: framework
tags: google javascript-runtime
iconSlug: angular
permalink: /angular
versionCommand: ng version
Expand Down
1 change: 1 addition & 0 deletions products/ansible-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ activeSupportColumn: false
eolColumn: Supported
iconSlug: ansible
category: framework
tags: python-runtime red-hat
auto:
- git: https://github.com/ansible/ansible.git
releases:
Expand Down
1 change: 1 addition & 0 deletions products/ansible.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Ansible
category: app
tags: python-runtime red-hat
iconSlug: ansible
permalink: /ansible
# The following command works from Ansible 6.0.0 on:
Expand Down
1 change: 1 addition & 0 deletions products/antixlinux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: antiX Linux
category: os
tags: linux-distribution
permalink: /antix
alternate_urls:
- /antixlinux
Expand Down
1 change: 1 addition & 0 deletions products/apache-airflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ releasePolicyLink: https://github.com/apache/airflow#version-life-cycle
changelogTemplate: https://airflow.apache.org/docs/apache-airflow/stable/release_notes.html#airflow-{{"__LATEST__"
| replace:'.','-'}}-{{"__LATEST_RELEASE_DATE__"}}
category: framework
tags: apache python-runtime
activeSupportColumn: false
versionCommand: airflow version
releaseColumn: true
Expand Down
3 changes: 2 additions & 1 deletion products/apache-camel.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Apache Camel
category: framework
tags: apache java-runtime
permalink: /apache-camel
alternate_urls:
- /camel
- /camel-lang
category: framework
releasePolicyLink: https://camel.apache.org/blog/2020/03/LTS-Release-Schedule/
changelogTemplate: https://camel.apache.org/releases/release-__LATEST__/
releaseColumn: true
Expand Down
1 change: 1 addition & 0 deletions products/apache-cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ iconSlug: apachecassandra
releaseDateColumn: true
changelogTemplate: 'https://gitbox.apache.org/repos/asf?p=cassandra.git;a=blob_plain;f=NEWS.txt;hb=refs/tags/cassandra-__LATEST__'
category: db
tags: apache java-runtime
releasePolicyLink: https://cassandra.apache.org/_/blog/Behind-the-scenes-of-an-Apache-Cassandra-Release.html
auto:
- git: https://github.com/apache/cassandra.git
Expand Down
1 change: 1 addition & 0 deletions products/apache-groovy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ alternate_urls:
- /groovy
- /groovy-lang
category: lang
tags: apache java-runtime
iconSlug: apachegroovy
releasePolicyLink: https://groovy.apache.org/versioning.html
changelogTemplate: https://groovy-lang.org/changelogs/changelog-__LATEST__.html
Expand Down
1 change: 1 addition & 0 deletions products/apache-http-server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Apache HTTP Server
category: server-app
tags: apache web-server
iconSlug: apache
permalink: /apache
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/apache-kafka.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Apache Kafka
category: server-app
tags: apache java-runtime
iconSlug: apachekafka
permalink: /apache-kafka
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/apache-maven.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Apache Maven
category: app
tags: apache java-runtime
versionCommand: mvn --version
permalink: /maven
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/api-platform.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Platform
category: framework
tags: php-runtime
permalink: /api-platform
versionCommand: composer show api-platform/core | grep versions
releasePolicyLink: https://api-platform.com/docs/extra/releases/
Expand Down
1 change: 1 addition & 0 deletions products/azul-zulu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Azul Zulu
category: lang
tags: azul java-distribution
iconSlug: openjdk
permalink: /azul-zulu
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/azure-devops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Azure DevOps Server
category: server-app
tags: microsoft
iconSlug: azuredevops
permalink: /azure-devops-server
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/azure-kubernetes-service.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Azure Kubernetes Service
category: service
tags: managed-kubernetes microsoft
iconSlug: microsoftazure
permalink: /azure-kubernetes-service
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/beats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Elastic Beats
category: server-app
tags: elastic
iconSlug: beats
permalink: /beats
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/bellsoft-liberica.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bellsoft Liberica JDK
category: lang
tags: bellsoft java-distribution
iconSlug: openjdk
permalink: /bellsoft-liberica
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/bootstrap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bootstrap
category: framework
tags: css-runtime javascript-runtime
iconSlug: bootstrap
permalink: /bootstrap
activeSupportColumn: true
Expand Down
1 change: 1 addition & 0 deletions products/cakephp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: CakePHP
category: framework
tags: php-runtime
iconSlug: cakephp
permalink: /cakephp
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/centos-stream.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: CentOS Stream
category: os
tags: linux-distribution
iconSlug: centos
permalink: /centos-stream
versionCommand: cat /etc/redhat-release
Expand Down
1 change: 1 addition & 0 deletions products/centos.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: CentOS
category: os
tags: linux-distribution
iconSlug: centos
permalink: /centos
versionCommand: cat /etc/redhat-release
Expand Down
1 change: 1 addition & 0 deletions products/citrix-apps-desktops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Citrix Virtual Apps and Desktops
category: app
tags: citrix
iconSlug: citrix
permalink: /citrix-vad
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/coldfusion.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Adobe ColdFusion
category: server-app
tags: adobe
iconSlug: adobe
permalink: /coldfusion
versionCommand: writeoutput(server.coldfusion.productversion);
Expand Down
1 change: 1 addition & 0 deletions products/composer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Composer
category: app
tags: php-runtime
changelogTemplate: https://getcomposer.org/changelog/__LATEST__
iconSlug: composer
permalink: /composer
Expand Down
1 change: 1 addition & 0 deletions products/confluence.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Confluence
category: server-app
tags: atlassian java-runtime
iconSlug: confluence
permalink: /confluence
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/consul.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Hashicorp Consul
category: server-app
tags: hashicorp
iconSlug: consul
permalink: /consul
versionCommand: consul --version
Expand Down
1 change: 1 addition & 0 deletions products/cos.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Google Container-Optimized OS (COS)
category: os
tags: google
changelogTemplate: "https://cloud.google.com/container-optimized-os/docs/release-notes/m{{'__RELEASE_CYCLE__'|split:'-'|last}}"
iconSlug: googlecloud
permalink: /cos
Expand Down
2 changes: 1 addition & 1 deletion products/couchbase-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ releases:

---

> [Couchbase Server](https://www.couchbase.com/products/server) is a modern cloud-native, distributed database that fuses the strengths of relational databases such as SQL and ACID transactions with JSON flexibility and scale that defines NoSQL. It is available as a service in commercial clouds and supports hybrid and private cloud deployments.
> [Couchbase Server](https://www.couchbase.com/products/server) is a modern cloud-native, distributed database that fuses the strengths of relational databases such as SQL and ACID transactions with JSON flexibility and scale that defines NoSQL. It is available as a service in commercial clouds and supports hybrid and private cloud deployments.
Security updates stop when a release reaches end of "Full Maintenance". Major versions are supported for the longer period between:

Expand Down
1 change: 1 addition & 0 deletions products/craft-cms.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Craft CMS
category: server-app
tags: php-runtime
iconSlug: craftcms
permalink: /craft-cms
alternate_urls:
Expand Down
1 change: 1 addition & 0 deletions products/debian.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Debian
category: os
tags: linux-distribution
iconSlug: debian
permalink: /debian
versionCommand: cat /etc/os-release
Expand Down
1 change: 1 addition & 0 deletions products/dependencytrack.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Dependency-Track
category: server-app
tags: java-runtime
permalink: /dependency-track
alternate_urls:
- /dependencytrack
Expand Down
1 change: 1 addition & 0 deletions products/devuan.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ permalink: /devuan
title: Devuan
versionCommand: cat /etc/os-release
category: os
tags: linux-distribution
releasePolicyLink: https://www.devuan.org/os/releases
activeSupportColumn: false
releaseColumn: true
Expand Down
Loading

0 comments on commit 6d9a994

Please sign in to comment.