Update new package README template #2707
Open
+90
−52
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).
|
The new README template in Kibana, with no changes made to it:
|
mjwolf
requested review from
mrodm,
colleenmcginnis,
kgeller,
alaudazzi,
benironside,
haetamoudi,
jsoriano,
qcorporation,
andrewkroh,
lucabelluccini,
theletterf,
bmorelli25 and
jamiehynds
⏳ Build in-progress, with failures
Failed CI StepsHistory
|
mjwolf
commented
Jul 4, 2025
| @@ -204,6 +209,9 @@ func renderReadme(fileName, packageRoot, templatePath string, linksMap linkMap) | |||
| } | |||
| return linksMap.RenderLink(args[0], options) | |||
| }, | |||
| "header": func(args ...string) (string, error) { | |||
There was a problem hiding this comment.
This depends on the user leaving ``{{header}}` in the readme in order to add the "Do not modify" string to the generated files.
I could also inject the string into all generated READMEs, regardless of if this {{header}} is in it, but I don't know if this would cause problems with other package types, so I didn't do that. If it won't cause problems, I could change to add to all generated files.
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.
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, 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}}).