Skip to content

[docs] Add products to docset.yml #4083

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented May 14, 2025

Related to elastic/docs-builder#1200

Add products to docset.yml to be used in the search experience.

cc @KOTungseth

@colleenmcginnis colleenmcginnis self-assigned this May 14, 2025
@colleenmcginnis colleenmcginnis added docs Documentation Team:Docs Label for the Observability docs team labels May 14, 2025
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@github-actions github-actions bot added agent-java community Issues and PRs created by the community triage labels May 14, 2025
@colleenmcginnis colleenmcginnis requested a review from a team May 14, 2025 23:24
@colleenmcginnis colleenmcginnis marked this pull request as ready for review May 14, 2025 23:24
@@ -1,4 +1,6 @@
project: 'APM Java agent docs'
products:
- id: apm-agent
Copy link
Contributor

Choose a reason for hiding this comment

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

not sure what this is for, so I don't know if this is supposed to be - id: apm-agent-java ?

Copy link

@vishaangelova vishaangelova May 15, 2025

Choose a reason for hiding this comment

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

Hi @jackshirazi, the products frontmatter specifies the list of products that the docset relates to, and is used to generate metadata during the build process, which, in turn, is used in the search experience to allow users to filter by product.

There are no separate product IDs for the different APM agents, they all fall under apm-agent (here’s a list of the valid product IDs).

@colleenmcginnis please correct me if I'm wrong.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @vishaangelova ! That's correct.

@jackshirazi This value will be added as metadata in the HTML for the web team to use to develop search filters. We might add metadata for specific platforms/languages in the future, but for now we're using more general terms.

Copy link

@vishaangelova vishaangelova left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-java community Issues and PRs created by the community docs Documentation Team:Docs Label for the Observability docs team triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants