Skip to content

Update applies_to Stack/Serverless/Deploy/Product render order #1727

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

Jump to bottom
Merged
merged 8 commits into from
Aug 27, 2025
Merged

Update applies_to Stack/Serverless/Deploy/Product render order #1727

merged 8 commits into from
Aug 27, 2025

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Aug 12, 2025 •
edited
Loading

Summary

applies_to badges are rendered in a predefined order. This PR reorders the applies_to badge rendering in ApplicableToComponent.cshtml to follow a more logical hierarchy. The new order prioritizes Stack, then Serverless, followed by deployment options, then specialized tools and agents.

Important

I might not have this order correct. I welcome any opinions on what the correct order is.

I did try putting Serverless first, but there are some edge-case sections like this one where Stack really gets buried if it comes after Serverless. Thoughts?

I also considered creating a configuration file for the badge ordering, but opted for keeping the hardcoded config as this ordering is unlikely to change often and in its current state doesn't require any runtime configuration lookup.

New Rendering Order

1. Stack

  • Stack

2. Serverless

  • Serverless (when all projects share same applicability)
  • Serverless Elasticsearch
  • Serverless Observability
  • Serverless Security

3. Deployment

  • ECH
  • ECK
  • ECE
  • Self-Managed

4. ProductApplicability

  • ECCTL
  • Curator
  • EDOT (alphabetical):
    • EDOT Android
    • EDOT CF AWS
    • EDOT Collector
    • EDOT .NET
    • EDOT iOS
    • EDOT Java
    • EDOT Node.js
    • EDOT PHP
    • EDOT Python
  • APM Agents (alphabetical):
    • APM Agent Android
    • APM Agent .NET
    • APM Agent Go
    • APM Agent iOS
    • APM Agent Java
    • APM Agent Node.js
    • APM Agent PHP
    • APM Agent Python
    • APM Agent Ruby
    • APM Agent RUM

5. Product (generic)

  • Generic product applicability (catch-all)

@bmorelli25
update applies_to render order
f5cb51e 
Signed-off-by: bmorelli25 <[email protected]>
@bmorelli25
more complex test
b71689e 
Signed-off-by: bmorelli25 <[email protected]>
@bmorelli25
Add brief docs
6ef43d3 
Signed-off-by: bmorelli25 <[email protected]>
@bmorelli25 bmorelli25 requested review from a team as code owners August 12, 2025 03:22
@bmorelli25 bmorelli25 mentioned this pull request Aug 12, 2025
Closed
2 tasks
@github-actions
Copy link

github-actions bot commented Aug 12, 2025 •
edited
Loading

🔍 Preview links for changed docs

@theletterf theletterf mentioned this pull request Aug 12, 2025
Merged
@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Aug 12, 2025

In the existing Documenting versions and deployment types page (which was absorbed into other pages in #1614), we stated that the order should "reflect organizational priorities". The examples provided were that serverless should come before stack and the deployment types should be in this order: serverless (?), ech, eck, ece, self-managed. I'm not sure who came up with that guidance initially or if we want to follow it.

@shainaraskas
Copy link
Contributor

shainaraskas commented Aug 12, 2025

👋 that was me making stuff up (but based on the push to serverless, and the deprioritization of ECE)

I think stack can come before serverless given your concerns, but I'd put the deployent types in the following order:
ech, eck, ece,self

@colleenmcginnis colleenmcginnis mentioned this pull request Aug 14, 2025
Open
7 tasks
@bmorelli25
Merge branch 'main' into order-applies-to
a600aa8 
Signed-off-by: bmorelli25 <[email protected]>

# Conflicts:
#	docs/syntax/applies.md
#	tests/authoring/Applicability/AppliesToFrontMatter.fs
@bmorelli25
ECH,ECK,ECE,SELF
435421c 
Signed-off-by: bmorelli25 <[email protected]>
@bmorelli25
test deployment type order
57bd05a 
Signed-off-by: bmorelli25 <[email protected]>
@bmorelli25
Copy link
Member Author

bmorelli25 commented Aug 26, 2025

Thanks for the feedback. Apologies for missing it. Updated based on your suggested order.

@bmorelli25
add docs
f09b08e 
Signed-off-by: bmorelli25 <[email protected]>
Mpdreamz
Mpdreamz approved these changes Aug 27, 2025
View reviewed changes
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ty @bmorelli25

@Mpdreamz Mpdreamz merged commit 791f565 into main Aug 27, 2025
19 checks passed
@Mpdreamz Mpdreamz deleted the order-applies-to branch August 27, 2025 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mpdreamz Mpdreamz Mpdreamz approved these changes

Assignees

No one assigned

Labels

chore

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Implement multiple lifecycle state logic

5 participants

@bmorelli25 @colleenmcginnis @shainaraskas @Mpdreamz