Skip to content

Update new package README template #2707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Aug 8, 2025
Merged

Update new package README template #2707

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9c51732
Update new package README template
mjwolf Jul 1, 2025
c2323d2
Only create new files in integration packages
mjwolf Jul 1, 2025
65c93b4
Fix whitespace
mjwolf Jul 1, 2025
70e4bfd
Use new template for the test apache package readme
mjwolf Jul 2, 2025
ecf9bed
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 2, 2025
89b34ec
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 9, 2025
bd327d0
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 29, 2025
d901942
Updates for new doc template format
mjwolf Jul 30, 2025
fcef419
automatically prepend generated info to generated files; generate for…
kgeller Jul 31, 2025
d7fd5df
fixing tests
kgeller Jul 31, 2025
031eeaf
formatting
kgeller Jul 31, 2025
962358e
only generate to the _dev folder if not a content type, as they have …
kgeller Jul 31, 2025
e03d736
generated notice to test integrations
kgeller Jul 31, 2025
402120c
missed some generated notices
kgeller Jul 31, 2025
80d6c24
last one hopefully
kgeller Jul 31, 2025
9ebe678
Merge branch 'main' of github.com:elastic/elastic-package into docs-t…
kgeller Aug 1, 2025
4688fad
remove header function from template; fixing test and tweaking the te…
kgeller Aug 1, 2025
3977bc8
updating docs
kgeller Aug 4, 2025
10a490f
Merge branch 'main' of github.com:elastic/elastic-package into docs-t…
kgeller Aug 4, 2025
0e6cc14
updating templated based on impl feedback from ti_abusech
kgeller Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixing tests
  • Loading branch information
@kgeller
kgeller committed Jul 31, 2025
commit d7fd5dfa10f0126b267c710105ead2c5ce8cfaa0
24 changes: 18 additions & 6 deletions internal/docs/readme_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ func TestGenerateReadme(t *testing.T) {
readmeTemplateContents: `
# README
Introduction to the package`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package`,
},
Expand Down Expand Up @@ -83,7 +85,9 @@ func TestRenderReadmeWithLinks(t *testing.T) {
Introduction to the package
{{ url "foo" }}
{{ url "foo" "Example" }}`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package
http://www.example.com/bar
Expand Down Expand Up @@ -127,7 +131,9 @@ func TestRenderReadmeWithSampleEvent(t *testing.T) {
# README
Introduction to the package
{{ event "example" }}`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package
An example event for ` + "`example`" + ` looks as following:
Expand Down Expand Up @@ -184,7 +190,9 @@ func TesRenderReadmeWithFields(t *testing.T) {
# README
Introduction to the package
{{ fields }}`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package
**Exported fields**
Expand All @@ -207,7 +215,9 @@ Introduction to the package
# README
Introduction to the package
{{ fields "example" }}`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package
**Exported fields**
Expand All @@ -230,7 +240,9 @@ Introduction to the package
# README
Introduction to the package
{{ fields "notexist" }}`,
expected: `
expected: `<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->

# README
Introduction to the package
**Exported fields**
Expand Down
2 changes: 1 addition & 1 deletion internal/packages/archetype/_static/package-docs-readme.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The `{data stream name}` data stream provides events from {source} of the follow

### Sample Event

<!-- Repeat and fill in the comment block below for each data stream of the current type. {{ '{{event}}' }} will be replace by a sample event, taken from `sample_event.json`, when building this integration. -->
<!-- Repeat and fill in the comment block below for each data stream of the current type. {{ `{{event}}` }} will be replace by a sample event, taken from `sample_event.json`, when building this integration. -->
<!--
{{ `{{event {data_stream_name} }}` }}
-->
Expand Down