Skip to content

Update product list, alphabetize #1256

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
May 14, 2025
+47 −124
Merged

Update product list, alphabetize #1256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c54de85
update product list, alphabetize
colleenmcginnis May 13, 2025
8ea6e67
Merge branch 'main' into add-more-products
reakaleek May 14, 2025
007d1ad
Merge branch 'main' into add-more-products
colleenmcginnis May 14, 2025
cd23746
simplify product list
colleenmcginnis May 14, 2025
fb2d3d5
attempt to fix test
colleenmcginnis May 14, 2025
59ccb0d
clean up list and docs
colleenmcginnis May 14, 2025
a6f11d3
remove elasticsearch curator
colleenmcginnis May 14, 2025
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
84 changes: 23 additions & 61 deletions docs/syntax/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: This is a description of the page <2>
applies_to: <3>
serverless: all
products: <4>
- id: apm-java-agent
- id: edot-java
- id: apm-agent
- id: edot-sdk
---
```

Expand Down Expand Up @@ -50,73 +50,35 @@ The products frontmatter is a list of objects, each object has an `id` field.
| Product ID | Product Name |
|---------------------------------------------|-----------------------------------------------|
| `apm` | APM |
| `apm-android-agent` | APM Android Agent |
| `apm-attacher` | APM Attacher |
| `apm-aws-lambda-extension` | APM AWS Lambda extension |
| `apm-dotnet-agent` | APM .NET Agent |
| `apm-go-agent` | APM Go Agent |
| `apm-ios-agent` | APM iOS Agent |
| `apm-java-agent` | APM Java Agent |
| `apm-node-agent` | APM Node.js Agent |
| `apm-php-agent` | APM PHP Agent |
| `apm-python-agent` | APM Python Agent |
| `apm-ruby-agent` | APM Ruby Agent |
| `apm-rum-agent` | APM RUM Agent |
| `beats-logging-plugin` | Beats Logging plugin |
| `cloud-control-ecctl` | Cloud Control ECCTL |
| `cloud-enterprise` | Cloud Enterprise |
| `cloud-hosted` | Cloud Hosted |
| `cloud-kubernetes` | Cloud Kubernetes |
| `cloud-native-ingest` | Cloud Native Ingest |
| `cloud-serverless` | Cloud Serverless |
| `cloud-terraform` | Cloud Terraform |
| `apm-agent` | APM Agent |
| `auditbeat` | Auditbeat |
| `beats` | Beats |
| `cloud-control-ecctl` | Elastic Cloud Control ECCTL |
| `cloud-enterprise` | Elastic Cloud Enterprise |
| `cloud-hosted` | Elastic Cloud Hosted |
| `cloud-kubernetes` | Elastic Cloud Kubernetes |
| `cloud-serverless` | Elastic Cloud Serverless |
| `cloud-terraform` | Elastic Cloud Terraform |
| `ecs` | Elastic Common Schema (ECS) |
| `ecs-logging-dotnet` | ECS Logging .NET |
| `ecs-logging-go-logrus` | ECS Logging Go Logrus |
| `ecs-logging-go-zap` | ECS Logging Go Zap |
| `ecs-logging-go-zerolog` | ECS Logging Go Zerolog |
| `ecs-logging-java` | ECS Logging Java |
| `ecs-logging-node` | ECS Logging Node.js |
| `ecs-logging-php` | ECS Logging PHP |
| `ecs-logging-python` | ECS Logging Python |
| `ecs-logging-ruby` | ECS Logging Ruby |
| `edot-android` | Elastic Distribution of OpenTelemetry Android |
| `ecs-logging` | ECS Logging |
| `edot-sdk` | Elastic Distribution of OpenTelemetry SDK |
| `edot-collector` | Elastic Distribution of OpenTelemetry Collector |
| `edot-dotnet` | Elastic Distribution of OpenTelemetry .NET |
| `edot-ios` | Elastic Distribution of OpenTelemetry iOS |
| `edot-java` | Elastic Distribution of OpenTelemetry Java |
| `edot-nodejs` | Elastic Distribution of OpenTelemetry Node.js |
| `edot-php` | Elastic Distribution of OpenTelemetry PHP |
| `edot-python` | Elastic Distribution of OpenTelemetry Python |
| `elastic-agent` | Elastic Agent |
| `elastic-products-platform` | Elastic Products platform |
| `elastic-serverless-forwarder` | Elastic Serverless Forwarder |
| `elastic-stack` | Elastic Stack |
| `elasticsearch` | Elasticsearch |
| `elasticsearch-apache-hadoop` | Elasticsearch Apache Hadoop |
| `elasticsearch-cloud-hosted-heroku` | Elasticsearch Cloud Hosted Heroku |
| `elasticsearch-community-clients` | Elasticsearch community clients |
| `elasticsearch-curator` | Elasticsearch Curator |
| `elasticsearch-dotnet-client` | Elasticsearch .NET Client |
| `elasticsearch-eland-python-client` | Elasticsearch Eland Python Client |
| `elasticsearch-go-client` | Elasticsearch Go Client |
| `elasticsearch-groovy-client` | Elasticsearch Groovy Client |
| `elasticsearch-java-client` | Elasticsearch Java Client |
| `elasticsearch-java-script-client` | Elasticsearch JavaScript Client |
| `elasticsearch-painless-scripting-language` | Elasticsearch Painless scripting language |
| `elasticsearch-perl-client` | Elasticsearch Perl Client |
| `elasticsearch-php-client` | Elasticsearch PHP Client |
| `elasticsearch-plugins` | Elasticsearch plugins |
| `elasticsearch-python-client` | Elasticsearch Python Client |
| `elasticsearch-resiliency-status` | Elasticsearch Resiliency Status |
| `elasticsearch-ruby-client` | Elasticsearch Ruby Client |
| `elasticsearch-rust-client` | Elasticsearch Rust Client |
| `elasticsearch-client` | Elasticsearch Client |
| `filebeat` | Filebeat |
| `fleet` | Fleet |
| `ingest` | Ingest |
| `heartbeat` | Heartbeat |
| `integrations` | Integrations |
| `kibana` | Kibana |
| `logstash` | Logstash |
| `machine-learning` | Machine Learning |
| `observability` | Observability |
| `reference-architectures` | Reference Architectures |
| `metricbeat` | Metricbeat |
| `observability` | Elastic Observability |
| `packetbeat` | Packetbeat |
| `painless` | Painless |
| `search-ui` | Search UI |
| `security` | Security |
| `security` | Elastic Security |
| `winlogbeat` | Winlogbeat |
83 changes: 22 additions & 61 deletions src/Elastic.Documentation.Configuration/Builder/Products.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,77 +12,38 @@ public static class Products
{
public static FrozenSet<Product> All { get; } = [
new("apm", "APM"),
new("apm-dotnet-agent", "APM .NET Agent"),
new("apm-android-agent", "APM Android Agent"),
new("apm-attacher", "APM Attacher"),
new("apm-aws-lambda-extension", "APM AWS Lambda extension"),
new("apm-go-agent", "APM Go Agent"),
new("apm-ios-agent", "APM iOS Agent"),
new("apm-java-agent", "APM Java Agent"),
new("apm-node-agent", "APM Node.js Agent"),
new("apm-php-agent", "APM PHP Agent"),
new("apm-python-agent", "APM Python Agent"),
new("apm-ruby-agent", "APM Ruby Agent"),
new("apm-rum-agent", "APM RUM Agent"),
new("beats-logging-plugin", "Beats Logging plugin"),
new("cloud-control-ecctl", "Cloud Control ECCTL"),
new("cloud-enterprise", "Cloud Enterprise"),
new("cloud-hosted", "Cloud Hosted"),
new("cloud-kubernetes", "Cloud Kubernetes"),
new("cloud-native-ingest", "Cloud Native Ingest"),
new("cloud-serverless", "Cloud Serverless"),
new("cloud-terraform", "Cloud Terraform"),
new("apm-agent", "APM Agent"),
new("auditbeat", "Auditbeat"),
new("beats", "Beats"),
new("cloud-control-ecctl", "Elastic Cloud Control ECCTL"),
new("cloud-enterprise", "Elastic Cloud Enterprise"),
new("cloud-hosted", "Elastic Cloud Hosted"),
new("cloud-kubernetes", "Elastic Cloud Kubernetes"),
new("cloud-serverless", "Elastic Cloud Serverless"),
new("cloud-terraform", "Elastic Cloud Terraform"),
new("ecs", "Elastic Common Schema (ECS)"),
new("ecs-logging", "ECS Logging"),
new("ecs-logging-dotnet", "ECS Logging .NET"),
new("ecs-logging-go-logrus", "ECS Logging Go Logrus"),
new("ecs-logging-go-zap", "ECS Logging Go Zap"),
new("ecs-logging-go-zerolog", "ECS Logging Go Zerolog"),
new("ecs-logging-java", "ECS Logging Java"),
new("ecs-logging-node", "ECS Logging Node.js"),
new("ecs-logging-php", "ECS Logging PHP"),
new("ecs-logging-python", "ECS Logging Python"),
new("ecs-logging-ruby", "ECS Logging Ruby"),
new("edot-sdk", "Elastic Distribution of OpenTelemetry SDK"),
new("edot-collector", "Elastic Distribution of OpenTelemetry Collector"),
new("elastic-agent", "Elastic Agent"),
new("ecs", "Elastic Common Schema (ECS)"),
new("elastic-products-platform", "Elastic Products platform"),
new("elastic-serverless-forwarder", "Elastic Serverless Forwarder"),
new("elastic-stack", "Elastic Stack"),
new("elasticsearch", "Elasticsearch"),
new("elasticsearch-dotnet-client", "Elasticsearch .NET Client"),
new("elasticsearch-apache-hadoop", "Elasticsearch Apache Hadoop"),
new("elasticsearch-cloud-hosted-heroku", "Elasticsearch Cloud Hosted Heroku"),
new("elasticsearch-community-clients", "Elasticsearch community clients"),
new("elasticsearch-curator", "Elasticsearch Curator"),
new("elasticsearch-eland-python-client", "Elasticsearch Eland Python Client"),
new("elasticsearch-go-client", "Elasticsearch Go Client"),
new("elasticsearch-groovy-client", "Elasticsearch Groovy Client"),
new("elasticsearch-java-client", "Elasticsearch Java Client"),
new("elasticsearch-java-script-client", "Elasticsearch JavaScript Client"),
new("elasticsearch-painless-scripting-language", "Elasticsearch Painless scripting language"),
new("elasticsearch-perl-client", "Elasticsearch Perl Client"),
new("elasticsearch-php-client", "Elasticsearch PHP Client"),
new("elasticsearch-plugins", "Elasticsearch plugins"),
new("elasticsearch-python-client", "Elasticsearch Python Client"),
new("elasticsearch-resiliency-status", "Elasticsearch Resiliency Status"),
new("elasticsearch-ruby-client", "Elasticsearch Ruby Client"),
new("elasticsearch-rust-client", "Elasticsearch Rust Client"),
new("elasticsearch-client", "Elasticsearch Client"),
new("filebeat", "Filebeat"),
new("fleet", "Fleet"),
new("ingest", "Ingest"),
new("heartbeat", "Heartbeat"),
new("integrations", "Integrations"),
new("kibana", "Kibana"),
new("logstash", "Logstash"),
new("machine-learning", "Machine Learning"),
new("observability", "Observability"),
new("reference-architectures", "Reference Architectures"),
new("metricbeat", "Metricbeat"),
new("observability", "Elastic Observability"),
new("packetbeat", "Packetbeat"),
new("painless", "Elasticsearch Painless scripting language"),
new("search-ui", "Search UI"),
new("security", "Security"),
new("edot-collector", "Elastic Distribution of OpenTelemetry Collector"),
new("edot-java", "Elastic Distribution of OpenTelemetry Java"),
new("edot-dotnet", "Elastic Distribution of OpenTelemetry .NET"),
new("edot-nodejs", "Elastic Distribution of OpenTelemetry Node.js"),
new("edot-php", "Elastic Distribution of OpenTelemetry PHP"),
new("edot-python", "Elastic Distribution of OpenTelemetry Python"),
new("edot-android", "Elastic Distribution of OpenTelemetry Android"),
new("edot-ios", "Elastic Distribution of OpenTelemetry iOS")
new("security", "Elastic Security"),
new("winlogbeat", "Winlogbeat"),
];

public static FrozenDictionary<string, Product> AllById { get; } = All.ToDictionary(p => p.Id, StringComparer.Ordinal).ToFrozenDictionary();
Expand Down
4 changes: 2 additions & 2 deletions tests/Elastic.Markdown.Tests/FrontMatter/YamlFrontMatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public class ProductsSuggestionWhenMispelled2(ITestOutputHelper output) : Direct
"""
---
products:
- id: apm-javaagent
- id: apmagent
---

# APM
Expand All @@ -143,7 +143,7 @@ public class ProductsSuggestionWhenMispelled2(ITestOutputHelper output) : Direct
public void HasErrors()
{
Collector.Diagnostics.Should().HaveCount(1);
Collector.Diagnostics.Should().Contain(d => d.Message.Contains("Invalid products frontmatter value: \"apm-javaagent\". Did you mean \"apm-java-agent\"?"));
Collector.Diagnostics.Should().Contain(d => d.Message.Contains("Invalid products frontmatter value: \"apmagent\". Did you mean \"apm-agent\"?"));
}
}

Expand Down
Loading