elastic / elastic/elastic-package

Add CI check to verify readme.mdx files

Open
#805 0 comments 0 reactions 0 assignees View on GitHub
Team:Ecosystem
Dominant language
Go
Stars
72
Forks
141
Avg merge
19h 42m
Merged PRs (30d)
55

Description

Follow-up on: https://github.com/elastic/integrations/issues/3260

If we decide to generate `readme.mdx` files, then we have to enable a CI mechanism to check if they are correct. We should ensure that it's enabled for all repositories with packages.

It would be nice to include it in the package- spec.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked follow-up issue 3260 and inspect how the package-spec is handled. Then locate existing CI checks for package repositories and determine where readme.mdx validation should be enabled. Done means all repositories with packages verify their readme.mdx files, with the check represented in the package-spec if applicable.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.