feat: add resource doc template and mise task#2540
Merged
Conversation
Automaat
requested review from
bartsmykla and
schogges
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds tooling to standardize creation of resource reference documentation for Kuma resources like Mesh, MeshService, etc. It introduces a template-based workflow that automates the initial structure for new resource docs.
- Adds
templates/resource.mdtemplate with standard structure for resource documentation - Creates
tools/new-resource-doc.shscript to generate docs from the template - Adds
mise new:resourcetask for convenient doc generation via mise - Includes comprehensive shellspec tests for the generation script
- Documents the new workflow in CONTRIBUTING.md
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/resource.md | New template defining standard structure for resource reference docs including frontmatter, spec fields, examples, and schema sections |
| tools/new-resource-doc.sh | Shell script that generates resource doc files from template by replacing placeholders and creating lowercase filenames |
| tools/spec/new_resource_doc_spec.sh | Shellspec test suite covering argument validation, file creation, placeholder replacement, and error handling |
| mise.toml | Adds new:resource task that wraps the generation script for ease of use |
| CONTRIBUTING.md | Documents the new resource doc creation workflow with usage examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
✅ Deploy Preview for kuma ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Automaat
force-pushed
the
feat/resource-doc-template
branch
2 times, most recently
from
0607613 to
47fe7d6
Compare
Add template and tooling for creating new resource reference docs: - templates/resource.md with Go template syntax - gomplate as mise dependency for template rendering - mise new:resource task for doc generation Usage: mise new:resource MeshService Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Automaat
force-pushed
the
feat/resource-doc-template
branch
from
47fe7d6 to
24b45e8
Compare
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
bartsmykla
approved these changes
Nov 27, 2025
This was referenced Nov 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Add tooling to standardize creation of resource reference docs (Mesh, MeshService, etc).
Implementation information
templates/resource.md- Go template with standard structure for resource docsgomplateadded as mise tool dependency for template renderingmise new:resourcetask with inline scriptUsage:
mise new:resource MeshService # Creates app/_src/resources/meshservice.mdAlso excludes
templates/from vale linting in CI and mise task.Supporting documentation
Part of plan to add "Core Resources" section to docs. See
.plans/core-resources-section.md.