elastic / elastic/docs-content

Code snippet testing for Elastic documentation — requirements

Open
#6,344 1 comment 0 reactions 1 assignee Claimed by @charlotte-hoblik View on GitHub
Team:Developer
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

## Summary
George has asked us to work on an initiative to test code snippets in the Elastic documentation. This issue tracks the research phase: gathering requirements, evaluating approaches, and documenting findings in the shared requirements Google Doc

## Context & resources
### Our existing repo:

- [elastic/exemplipy](https://github.com/elastic/exemplipy) — Elastic's repo for Python-based documentation snippet testing

### Relevant
- Blog post: [How Drasi used GitHub Copilot to find documentation bugs](https://opensource.microsoft.com/blog/2026/04/09/how-drasi-used-github-copilot-to-find-documentation-bugs/)
- Drasi is a CNCF sandbox project with a small team of 4 engineers.
They used GitHub Copilot CLI and AI agents to automatically test tutorials and prevent documentation drift.
- Their devcontainer setup: [drasi-project/learning/.devcontainer](https://github.com/drasi-project/learning/tree/main/.devcontainer) — worth looking at for how they structure testable tutorial environments.

### Requirements Google Doc:

- [Google Doc link](https://docs.google.com/document/d/1Oxvbgl9tg2m7Kb-sAQa3u8rAgg7nBaO6ySj-0H3dKO0/edit?usp=sharing) — this is where requirements should be documented

What needs to happen

- [x] Review the elastic/exemplipy repo — understand its current state and capabilities.
- [x] Review the Drasi blog post and their devcontainer approach for applicability to Elastic docs.
- [x] Assess whether the Drasi/Copilot-based approach (using AI agents to walk through tutorials in devcontainers) could work for Elastic docs.
- [x] Document requirements in the Google Doc (what snippets to test, which languages, how to run, CI integration, etc.).
- [x] Set up meeting with George to report findings

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.