feat(core): improve SEO on plugin documentation

kestra-io · Apr 17, 2023 · 27404b7 · 27404b7
1 parent 38dba95
commit 27404b7
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/core/src/main/java/io/kestra/core/docs/ClassPluginDocumentation.java b/core/src/main/java/io/kestra/core/docs/ClassPluginDocumentation.java
@@ -18,6 +18,7 @@ public class ClassPluginDocumentation<T> {
     private String cls;
     private String icon;
     private String group;
+    private String pluginTitle;
     private String subGroup;
     private String shortName;
     private String docDescription;
@@ -35,6 +36,7 @@ public class ClassPluginDocumentation<T> {
     private ClassPluginDocumentation(JsonSchemaGenerator jsonSchemaGenerator, RegisteredPlugin plugin, Class<? extends T> cls, Class<T> baseCls) {
         this.cls = cls.getName();
         this.group = plugin.group();
+        this.pluginTitle = plugin.title();
         this.icon = DocumentationGenerator.icon(plugin, cls);
 
         if (this.group != null && cls.getPackageName().startsWith(this.group) && cls.getPackageName().length() > this.group.length()) {

diff --git a/core/src/main/resources/docs/index.hbs b/core/src/main/resources/docs/index.hbs
@@ -1,5 +1,6 @@
 ---
 title: {{ capitalizeFirst (replace title "-" " ") }}
+{{#if description}}description: {{ description }}{{~/if}}
 editLink: false
 {{#if icon}}icon: {{ icon }}{{~/if}}
 ---

diff --git a/core/src/main/resources/docs/task.hbs b/core/src/main/resources/docs/task.hbs
@@ -1,8 +1,8 @@
 ---
-title: {{json shortName}}
+title: {{ capitalizeFirst (replace pluginTitle "-" " ") }} {{shortName}}
 editLink: false
 {{#if docDescription}}
-description: {{ json docDescription }}
+description: {{ docDescription }}
 {{~/if}}
 {{#if icon}}
 icon: {{ icon }}

diff --git a/core/src/test/java/io/kestra/core/docs/DocumentationGeneratorTest.java b/core/src/test/java/io/kestra/core/docs/DocumentationGeneratorTest.java
@@ -43,7 +43,7 @@ void tasks() throws URISyntaxException, IOException {
         String render = DocumentationGenerator.render(doc);
 
         assertThat(render, containsString("ExampleTask"));
-        assertThat(render, containsString("description: \"Short description for this task\""));
+        assertThat(render, containsString("description: Short description for this task"));
         assertThat(render, containsString("`VALUE_1`"));
         assertThat(render, containsString("`VALUE_2`"));
     }