Version template for package docs (#4568) (#4794)

Co-authored-by: Juan Álvarez <[email protected]>
elastic · Feb 18, 2021 · 75f4b51 · 75f4b51
1 parent 263be12
commit 75f4b51
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/apmpackage/README.md b/apmpackage/README.md
@@ -10,7 +10,7 @@
 #### Update / fix a package
 
 1. Actual work
-    - Make changes in `apmpackage/apm/<version>`, `apmpackage/docs/README.template.md` and/or code as needed
+    - Make changes in `apmpackage/apm/<version>` and/or code as needed
     - Run `make update`. That will update fields, pipeline and doc files based on apm-server fields and pipeline defs.
 
 2. Run the registry

diff --git a/apmpackage/docs/README.template.md → ...ge/apm/0.1.0/_dev/docs/README.template.md b/apmpackage/docs/README.template.md → ...ge/apm/0.1.0/_dev/docs/README.template.md
diff --git a/apmpackage/cmd/gen-package/gendocs.go b/apmpackage/cmd/gen-package/gendocs.go
@@ -36,10 +36,10 @@ func generateDocs(inputFields map[string][]field, version string) {
 		MetricsExample:     loadExample("metricsets.json"),
 		ErrorExample:       loadExample("errors.json"),
 	}
-	t := template.New(docsTemplateFilePath)
+	t := template.New(docsTemplateFilePath(version))
 	tmpl, err := t.Funcs(map[string]interface{}{
 		"Trim": strings.TrimSpace,
-	}).ParseFiles(docsTemplateFilePath)
+	}).ParseFiles(docsTemplateFilePath(version))
 	if err != nil {
 		panic(err)
 	}

diff --git a/apmpackage/cmd/gen-package/paths.go b/apmpackage/cmd/gen-package/paths.go
@@ -19,7 +19,9 @@ package main
 
 import "path/filepath"
 
-var docsTemplateFilePath = "apmpackage/docs/README.template.md"
+func docsTemplateFilePath(version string) string {
+	return filepath.Join("apmpackage/apm/", version, "/_dev/docs/README.template.md")
+}
 
 func docsFilePath(version string) string {
 	return filepath.Join("apmpackage/apm/", version, "/docs/README.md")