Update new package README template #2707
Merged
Conversation
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
Update the README templates and generator used in new package creation to match the new standardized README structure. The updated template should be better at helping users write the readme, by explaining what is needed in each section of the template. This also makes a few other small changes which will make it easier for new users to create integration packages. It moves the generated readme to `_dev/build/docs`, adds a "Do not modify" message to the README generated during `build`, and adds a default sample-event (which is needed to build the update readme template).
Rewrite the readme for the test apache package to use the new docs format. NOTE: This format isn't used in the published apache integration.
| The new README template in Kibana, with no changes made to it:
|
mjwolf requested review from alaudazzi, andrewkroh, benironside, bmorelli25, colleenmcginnis, haetamoudi, jamiehynds, jsoriano, kgeller, lucabelluccini, mrodm, qcorporation and theletterf 
mjwolf commented Jul 4, 2025
jsoriano reviewed Jul 5, 2025
The I can also modify one of the test packages in elastic-package, so there's an example of new template here. |
| I've changed the readme in the |
jsoriano reviewed Jul 16, 2025
kgeller reviewed Jul 24, 2025
internal/packages/archetype/_static/package-docs-readme.md.tmpl Outdated Show resolved Hide resolved
* Add comments on adding datastream fields and events to doc template * Generate fields in "apache" test package docs
… all package types
jsoriano reviewed Aug 1, 2025
internal/packages/archetype/_static/package-docs-readme.md.tmpl Outdated Show resolved Hide resolved
💚 Build Succeeded
History
|
jsoriano reviewed Aug 5, 2025
jsoriano approved these changes Aug 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
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.
Update the README templates and generator used in new package creation to match the new standardized README structure. The updated template should be better at helping users write the readme for new packages, by explaining what is needed in each section of the template.
This also makes a few other small changes which will make it easier for new users to create and use integration packages. It moves the generated readme to
_dev/build/docs, automatically adds a "Do not modify" message to the README generated duringbuild, and adds a default sample-event (which is needed to build the update readme template, since it now includes{{event}}).