Skip to content

Commit 0c267f9

Browse files
colleenmcginnisreakaleek
colleenmcginnis
and
reakaleek
authored
Update product list, alphabetize (#1256)
* update product list, alphabetize * simplify product list * attempt to fix test * clean up list and docs * remove elasticsearch curator --------- Co-authored-by: Jan Calanog <[email protected]>
1 parent ed4f058 commit 0c267f9

File tree

3 files changed

+47
-124
lines changed

3 files changed

+47
-124
lines changed

‎docs/syntax/frontmatter.md

Lines changed: 23 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ description: This is a description of the page <2>
1313
applies_to: <3>
1414
serverless: all
1515
products: <4>
16-
- id: apm-java-agent
17-
- id: edot-java
16+
- id: apm-agent
17+
- id: edot-sdk
1818
---
1919
```
2020

@@ -50,73 +50,35 @@ The products frontmatter is a list of objects, each object has an `id` field.
5050
| Product ID | Product Name |
5151
|---------------------------------------------|-----------------------------------------------|
5252
| `apm` | APM |
53-
| `apm-android-agent` | APM Android Agent |
54-
| `apm-attacher` | APM Attacher |
55-
| `apm-aws-lambda-extension` | APM AWS Lambda extension |
56-
| `apm-dotnet-agent` | APM .NET Agent |
57-
| `apm-go-agent` | APM Go Agent |
58-
| `apm-ios-agent` | APM iOS Agent |
59-
| `apm-java-agent` | APM Java Agent |
60-
| `apm-node-agent` | APM Node.js Agent |
61-
| `apm-php-agent` | APM PHP Agent |
62-
| `apm-python-agent` | APM Python Agent |
63-
| `apm-ruby-agent` | APM Ruby Agent |
64-
| `apm-rum-agent` | APM RUM Agent |
65-
| `beats-logging-plugin` | Beats Logging plugin |
66-
| `cloud-control-ecctl` | Cloud Control ECCTL |
67-
| `cloud-enterprise` | Cloud Enterprise |
68-
| `cloud-hosted` | Cloud Hosted |
69-
| `cloud-kubernetes` | Cloud Kubernetes |
70-
| `cloud-native-ingest` | Cloud Native Ingest |
71-
| `cloud-serverless` | Cloud Serverless |
72-
| `cloud-terraform` | Cloud Terraform |
53+
| `apm-agent` | APM Agent |
54+
| `auditbeat` | Auditbeat |
55+
| `beats` | Beats |
56+
| `cloud-control-ecctl` | Elastic Cloud Control ECCTL |
57+
| `cloud-enterprise` | Elastic Cloud Enterprise |
58+
| `cloud-hosted` | Elastic Cloud Hosted |
59+
| `cloud-kubernetes` | Elastic Cloud Kubernetes |
60+
| `cloud-serverless` | Elastic Cloud Serverless |
61+
| `cloud-terraform` | Elastic Cloud Terraform |
7362
| `ecs` | Elastic Common Schema (ECS) |
74-
| `ecs-logging-dotnet` | ECS Logging .NET |
75-
| `ecs-logging-go-logrus` | ECS Logging Go Logrus |
76-
| `ecs-logging-go-zap` | ECS Logging Go Zap |
77-
| `ecs-logging-go-zerolog` | ECS Logging Go Zerolog |
78-
| `ecs-logging-java` | ECS Logging Java |
79-
| `ecs-logging-node` | ECS Logging Node.js |
80-
| `ecs-logging-php` | ECS Logging PHP |
81-
| `ecs-logging-python` | ECS Logging Python |
82-
| `ecs-logging-ruby` | ECS Logging Ruby |
83-
| `edot-android` | Elastic Distribution of OpenTelemetry Android |
63+
| `ecs-logging` | ECS Logging |
64+
| `edot-sdk` | Elastic Distribution of OpenTelemetry SDK |
8465
| `edot-collector` | Elastic Distribution of OpenTelemetry Collector |
85-
| `edot-dotnet` | Elastic Distribution of OpenTelemetry .NET |
86-
| `edot-ios` | Elastic Distribution of OpenTelemetry iOS |
87-
| `edot-java` | Elastic Distribution of OpenTelemetry Java |
88-
| `edot-nodejs` | Elastic Distribution of OpenTelemetry Node.js |
89-
| `edot-php` | Elastic Distribution of OpenTelemetry PHP |
90-
| `edot-python` | Elastic Distribution of OpenTelemetry Python |
9166
| `elastic-agent` | Elastic Agent |
92-
| `elastic-products-platform` | Elastic Products platform |
67+
| `elastic-serverless-forwarder` | Elastic Serverless Forwarder |
9368
| `elastic-stack` | Elastic Stack |
9469
| `elasticsearch` | Elasticsearch |
95-
| `elasticsearch-apache-hadoop` | Elasticsearch Apache Hadoop |
96-
| `elasticsearch-cloud-hosted-heroku` | Elasticsearch Cloud Hosted Heroku |
97-
| `elasticsearch-community-clients` | Elasticsearch community clients |
98-
| `elasticsearch-curator` | Elasticsearch Curator |
99-
| `elasticsearch-dotnet-client` | Elasticsearch .NET Client |
100-
| `elasticsearch-eland-python-client` | Elasticsearch Eland Python Client |
101-
| `elasticsearch-go-client` | Elasticsearch Go Client |
102-
| `elasticsearch-groovy-client` | Elasticsearch Groovy Client |
103-
| `elasticsearch-java-client` | Elasticsearch Java Client |
104-
| `elasticsearch-java-script-client` | Elasticsearch JavaScript Client |
105-
| `elasticsearch-painless-scripting-language` | Elasticsearch Painless scripting language |
106-
| `elasticsearch-perl-client` | Elasticsearch Perl Client |
107-
| `elasticsearch-php-client` | Elasticsearch PHP Client |
108-
| `elasticsearch-plugins` | Elasticsearch plugins |
109-
| `elasticsearch-python-client` | Elasticsearch Python Client |
110-
| `elasticsearch-resiliency-status` | Elasticsearch Resiliency Status |
111-
| `elasticsearch-ruby-client` | Elasticsearch Ruby Client |
112-
| `elasticsearch-rust-client` | Elasticsearch Rust Client |
70+
| `elasticsearch-client` | Elasticsearch Client |
71+
| `filebeat` | Filebeat |
11372
| `fleet` | Fleet |
114-
| `ingest` | Ingest |
73+
| `heartbeat` | Heartbeat |
11574
| `integrations` | Integrations |
11675
| `kibana` | Kibana |
11776
| `logstash` | Logstash |
11877
| `machine-learning` | Machine Learning |
119-
| `observability` | Observability |
120-
| `reference-architectures` | Reference Architectures |
78+
| `metricbeat` | Metricbeat |
79+
| `observability` | Elastic Observability |
80+
| `packetbeat` | Packetbeat |
81+
| `painless` | Painless |
12182
| `search-ui` | Search UI |
122-
| `security` | Security |
83+
| `security` | Elastic Security |
84+
| `winlogbeat` | Winlogbeat |

‎src/Elastic.Documentation.Configuration/Builder/Products.cs

Lines changed: 22 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -12,77 +12,38 @@ public static class Products
1212
{
1313
public static FrozenSet<Product> All { get; } = [
1414
new("apm", "APM"),
15-
new("apm-dotnet-agent", "APM .NET Agent"),
16-
new("apm-android-agent", "APM Android Agent"),
17-
new("apm-attacher", "APM Attacher"),
18-
new("apm-aws-lambda-extension", "APM AWS Lambda extension"),
19-
new("apm-go-agent", "APM Go Agent"),
20-
new("apm-ios-agent", "APM iOS Agent"),
21-
new("apm-java-agent", "APM Java Agent"),
22-
new("apm-node-agent", "APM Node.js Agent"),
23-
new("apm-php-agent", "APM PHP Agent"),
24-
new("apm-python-agent", "APM Python Agent"),
25-
new("apm-ruby-agent", "APM Ruby Agent"),
26-
new("apm-rum-agent", "APM RUM Agent"),
27-
new("beats-logging-plugin", "Beats Logging plugin"),
28-
new("cloud-control-ecctl", "Cloud Control ECCTL"),
29-
new("cloud-enterprise", "Cloud Enterprise"),
30-
new("cloud-hosted", "Cloud Hosted"),
31-
new("cloud-kubernetes", "Cloud Kubernetes"),
32-
new("cloud-native-ingest", "Cloud Native Ingest"),
33-
new("cloud-serverless", "Cloud Serverless"),
34-
new("cloud-terraform", "Cloud Terraform"),
15+
new("apm-agent", "APM Agent"),
16+
new("auditbeat", "Auditbeat"),
17+
new("beats", "Beats"),
18+
new("cloud-control-ecctl", "Elastic Cloud Control ECCTL"),
19+
new("cloud-enterprise", "Elastic Cloud Enterprise"),
20+
new("cloud-hosted", "Elastic Cloud Hosted"),
21+
new("cloud-kubernetes", "Elastic Cloud Kubernetes"),
22+
new("cloud-serverless", "Elastic Cloud Serverless"),
23+
new("cloud-terraform", "Elastic Cloud Terraform"),
24+
new("ecs", "Elastic Common Schema (ECS)"),
3525
new("ecs-logging", "ECS Logging"),
36-
new("ecs-logging-dotnet", "ECS Logging .NET"),
37-
new("ecs-logging-go-logrus", "ECS Logging Go Logrus"),
38-
new("ecs-logging-go-zap", "ECS Logging Go Zap"),
39-
new("ecs-logging-go-zerolog", "ECS Logging Go Zerolog"),
40-
new("ecs-logging-java", "ECS Logging Java"),
41-
new("ecs-logging-node", "ECS Logging Node.js"),
42-
new("ecs-logging-php", "ECS Logging PHP"),
43-
new("ecs-logging-python", "ECS Logging Python"),
44-
new("ecs-logging-ruby", "ECS Logging Ruby"),
26+
new("edot-sdk", "Elastic Distribution of OpenTelemetry SDK"),
27+
new("edot-collector", "Elastic Distribution of OpenTelemetry Collector"),
4528
new("elastic-agent", "Elastic Agent"),
46-
new("ecs", "Elastic Common Schema (ECS)"),
47-
new("elastic-products-platform", "Elastic Products platform"),
29+
new("elastic-serverless-forwarder", "Elastic Serverless Forwarder"),
4830
new("elastic-stack", "Elastic Stack"),
4931
new("elasticsearch", "Elasticsearch"),
50-
new("elasticsearch-dotnet-client", "Elasticsearch .NET Client"),
51-
new("elasticsearch-apache-hadoop", "Elasticsearch Apache Hadoop"),
52-
new("elasticsearch-cloud-hosted-heroku", "Elasticsearch Cloud Hosted Heroku"),
53-
new("elasticsearch-community-clients", "Elasticsearch community clients"),
54-
new("elasticsearch-curator", "Elasticsearch Curator"),
55-
new("elasticsearch-eland-python-client", "Elasticsearch Eland Python Client"),
56-
new("elasticsearch-go-client", "Elasticsearch Go Client"),
57-
new("elasticsearch-groovy-client", "Elasticsearch Groovy Client"),
58-
new("elasticsearch-java-client", "Elasticsearch Java Client"),
59-
new("elasticsearch-java-script-client", "Elasticsearch JavaScript Client"),
60-
new("elasticsearch-painless-scripting-language", "Elasticsearch Painless scripting language"),
61-
new("elasticsearch-perl-client", "Elasticsearch Perl Client"),
62-
new("elasticsearch-php-client", "Elasticsearch PHP Client"),
63-
new("elasticsearch-plugins", "Elasticsearch plugins"),
64-
new("elasticsearch-python-client", "Elasticsearch Python Client"),
65-
new("elasticsearch-resiliency-status", "Elasticsearch Resiliency Status"),
66-
new("elasticsearch-ruby-client", "Elasticsearch Ruby Client"),
67-
new("elasticsearch-rust-client", "Elasticsearch Rust Client"),
32+
new("elasticsearch-client", "Elasticsearch Client"),
33+
new("filebeat", "Filebeat"),
6834
new("fleet", "Fleet"),
69-
new("ingest", "Ingest"),
35+
new("heartbeat", "Heartbeat"),
7036
new("integrations", "Integrations"),
7137
new("kibana", "Kibana"),
7238
new("logstash", "Logstash"),
7339
new("machine-learning", "Machine Learning"),
74-
new("observability", "Observability"),
75-
new("reference-architectures", "Reference Architectures"),
40+
new("metricbeat", "Metricbeat"),
41+
new("observability", "Elastic Observability"),
42+
new("packetbeat", "Packetbeat"),
43+
new("painless", "Elasticsearch Painless scripting language"),
7644
new("search-ui", "Search UI"),
77-
new("security", "Security"),
78-
new("edot-collector", "Elastic Distribution of OpenTelemetry Collector"),
79-
new("edot-java", "Elastic Distribution of OpenTelemetry Java"),
80-
new("edot-dotnet", "Elastic Distribution of OpenTelemetry .NET"),
81-
new("edot-nodejs", "Elastic Distribution of OpenTelemetry Node.js"),
82-
new("edot-php", "Elastic Distribution of OpenTelemetry PHP"),
83-
new("edot-python", "Elastic Distribution of OpenTelemetry Python"),
84-
new("edot-android", "Elastic Distribution of OpenTelemetry Android"),
85-
new("edot-ios", "Elastic Distribution of OpenTelemetry iOS")
45+
new("security", "Elastic Security"),
46+
new("winlogbeat", "Winlogbeat"),
8647
];
8748

8849
public static FrozenDictionary<string, Product> AllById { get; } = All.ToDictionary(p => p.Id, StringComparer.Ordinal).ToFrozenDictionary();

‎tests/Elastic.Markdown.Tests/FrontMatter/YamlFrontMatterTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public class ProductsSuggestionWhenMispelled2(ITestOutputHelper output) : Direct
132132
"""
133133
---
134134
products:
135-
- id: apm-javaagent
135+
- id: apmagent
136136
---
137137
138138
# APM
@@ -143,7 +143,7 @@ public class ProductsSuggestionWhenMispelled2(ITestOutputHelper output) : Direct
143143
public void HasErrors()
144144
{
145145
Collector.Diagnostics.Should().HaveCount(1);
146-
Collector.Diagnostics.Should().Contain(d => d.Message.Contains("Invalid products frontmatter value: \"apm-javaagent\". Did you mean \"apm-java-agent\"?"));
146+
Collector.Diagnostics.Should().Contain(d => d.Message.Contains("Invalid products frontmatter value: \"apmagent\". Did you mean \"apm-agent\"?"));
147147
}
148148
}
149149

0 commit comments

Comments
 (0)