Skip to content

Add Agent Builder glossary#6175

Merged
charlotte-hoblik merged 31 commits into
mainfrom
charlotte-glossary-1059
May 7, 2026
Merged

Add Agent Builder glossary#6175
charlotte-hoblik merged 31 commits into
mainfrom
charlotte-glossary-1059

Conversation

@charlotte-hoblik
Copy link
Copy Markdown
Contributor

@charlotte-hoblik charlotte-hoblik commented Apr 28, 2026

Adds a new glossary.md page under explore-analyze/ai-features/agent-builder/ covering the terminology used across the Agent Builder docs. Entries are alphabetical, in definition-list format, with inline applies_to badges for terms scoped to specific versions.

URL preview: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6175/explore-analyze/ai-features/agent-builder/glossary

Closes https://github.com/elastic/docs-content-internal/issues/1059

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used:
Opus 4.7

@charlotte-hoblik charlotte-hoblik self-assigned this Apr 28, 2026
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner April 28, 2026 06:48
@charlotte-hoblik charlotte-hoblik added the documentation Improvements or additions to documentation label Apr 28, 2026
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner April 28, 2026 06:48
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

Vale Linting Results

Summary: 1 warning, 1 suggestion found

⚠️ Warnings (1)
File Line Rule Message
explore-analyze/ai-features/agent-builder/glossary.md 223 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'VS'.
💡 Suggestions (1)
File Line Rule Message
explore-analyze/ai-features/agent-builder/glossary.md 49 Elastic.Semicolons Use semicolons judiciously.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Docs review summary

Focus areas

  • Style and clarity: Two issues — a subjectless sentence fragment in the A2A server definition (line 31) and "LLM" used without expansion on first use (line 34). All other entries are clear and well-structured.
  • Jargon: "GenAI" appears throughout as the Kibana feature name (GenAI connector, GenAI Settings), which is acceptable as it matches the product UI. All other acronyms used in definition terms (RAG, MCP, A2A) are expanded within their own entries.
  • Frontmatter and applies_to: Frontmatter is present and complete — applies_to, products, description, and navigation_title all pass. Inline applies_to badges are used extensively; two placement issues flagged inline (lines 46 and 234) where badges precede rather than follow the content they scope.
  • Content type fit: Glossary is not one of the five standard Elastic content types (overview, how-to, tutorial, troubleshooting, changelog), so no type field is expected or required. Structure and formatting are appropriate for a reference glossary.
  • Parent issue satisfaction: Closes elastic/docs-content-internal#1059 (private). Based on the PR description, the ask was a terminology glossary for Agent Builder docs. The page covers the feature comprehensively and alphabetically with version badges — appears satisfied.

Nits

  • description (line 3): Starts with a noun phrase ("Definitions of the key terms...") rather than a verb. Suggest: "Defines the key terms used throughout the Elastic Agent Builder documentation." — a minor style-guide-based preference.

Notes

  • Vale is not installed in this environment; manual review was performed against the Elastic style guide rules.
  • The toc.yml change is out of scope for this markdown review.

Docs automation | From workflow: Docs review agent

React with 👍 if helpful, 👎 if not.

Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md
Comment thread explore-analyze/ai-features/agent-builder/glossary.md
@charlotte-hoblik
Copy link
Copy Markdown
Contributor Author

Thank you @akm-esco for the review 🙂

Copy link
Copy Markdown

@pgayvallet pgayvallet left a comment

Choose a reason for hiding this comment

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

(Feel free to ignore part or all of the comments)

Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
GenAI Settings {applies_to}`stack: ga 9.4+`
: The {{kib}} settings page where you configure the default model and other generative-AI options that affect {{agent-builder}}. See [Models](models.md).

## I
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

An entry for Inference endpoint (which are "replacing" AI connectors we're deprecating) maybe?

Copy link
Copy Markdown
Contributor Author

@charlotte-hoblik charlotte-hoblik May 5, 2026

Choose a reason for hiding this comment

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

Looked into this: the term isn't actually used in the AB docs yet. It only appears in mcp-server.md as a cluster-privilege footnote, and models.md/connectors.md still speak in connectors. Per the glossary's scope ("terms used throughout the AB documentation"), I'd hold off until those pages are rewritten around the AI Connector / inference endpoint model. Happy to add it then. What do you think?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd hold off until those pages are rewritten around the AI Connector / inference endpoint model

@charlotte-hoblik can you create a ticket for that and assign it to yourself for this new sprint

you can chat to Lisa about this, as she worked on the ES solution updates around inference endpoints :)

Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Copy link
Copy Markdown

@pgayvallet pgayvallet left a comment

Choose a reason for hiding this comment

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

And a couple more

Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment on lines +234 to +235
Slash command {applies_to}`stack: ga 9.4+`
: The chat shortcut for explicitly invoking a skill. Type `/` followed by the skill name to bypass automatic skill selection. See [Skills](skills.md).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is that the naming we ended up with? At some point we were naming those "Chat commands"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good question. I went and double-checked the docs. "Slash command" is the term in use inskills.md

@charlotte-hoblik charlotte-hoblik requested a review from akm-esco May 5, 2026 13:31
@charlotte-hoblik
Copy link
Copy Markdown
Contributor Author

Thank you for the review @pgayvallet 🙂

Copy link
Copy Markdown
Member

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Lots of similar feedback here, links should be targeted or removed.

We should add anchors to all of these too

Comment thread explore-analyze/ai-features/agent-builder/glossary.md
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
charlotte-hoblik and others added 18 commits May 5, 2026 18:54
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Copy link
Copy Markdown
Member

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

🚀

Comment thread explore-analyze/ai-features/agent-builder/glossary.md Outdated
@charlotte-hoblik charlotte-hoblik enabled auto-merge (squash) May 7, 2026 15:14
@charlotte-hoblik charlotte-hoblik merged commit 8224e6f into main May 7, 2026
11 of 12 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-glossary-1059 branch May 7, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants