-
Notifications
You must be signed in to change notification settings - Fork 323
[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
base: main
Are you sure you want to change the base?
[docs] Add products
to docset.yml
#4083
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
@@ -1,4 +1,6 @@ | |||
project: 'APM Java agent docs' | |||
products: | |||
- id: apm-agent |
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Related to elastic/docs-builder#1200
Add
products
todocset.yml
to be used in the search experience.cc @KOTungseth