Skip to content

adding snippet tests back to docs #136420

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
Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

adding snippet tests back to docs #136420

wants to merge 12 commits into from
+2,767 −250

Conversation

georgewallace
Copy link
Contributor

@georgewallace georgewallace commented Oct 10, 2025 •
edited
Loading

This PR:

  • adds snippet tests comments back to the docs based on existing snippet testing.
  • corrects examples that will break in testing
  • Fixed callouts in samples that were made with # instead of <#>.
  • Removed lines after examples that shouldn't be there.
  • Added commented out code snippets that are required for tests to complete.

This PR does not:

  • reenable testing

@georgewallace georgewallace force-pushed the update_snippet_comments branch from 4174b8b to bf150cd Compare October 10, 2025 16:34
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 10, 2025 •
edited
Loading

🔍 Preview links for changed docs

More links …

In total, 321 files changed.

@github-actions GitHub Actions
Copy link
Contributor

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

@georgewallace georgewallace marked this pull request as ready for review October 10, 2025 19:03
@georgewallace georgewallace requested review from a team and leemthompo October 10, 2025 19:03
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leemthompo leemthompo Awaiting requested review from leemthompo

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

needs:triage Requires assignment of a team area label v9.3.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@georgewallace @elasticsearchmachine