From 7328ef495032e1a3c258fd4ae980210b1a44d6bd Mon Sep 17 00:00:00 2001 From: Andy Damevin Date: Mon, 22 Aug 2022 16:35:42 +0200 Subject: [PATCH] Minor fixes in codestart doc --- docs/src/main/asciidoc/extension-codestart.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/src/main/asciidoc/extension-codestart.adoc b/docs/src/main/asciidoc/extension-codestart.adoc index ba5e77c01eab5..108912f1223f4 100644 --- a/docs/src/main/asciidoc/extension-codestart.adoc +++ b/docs/src/main/asciidoc/extension-codestart.adoc @@ -69,6 +69,8 @@ The https://github.com/quarkusio/quarkus/tree/main/independent-projects/tools/ba == Writing an Extension Codestart +Here is a step-by-step guide to write an extension codestart. You may also watch the https://www.youtube.com/watch?v=lLyVDqVK8cE[Quarkus Insight #99] with a live-coding session. + As was mentioned previously, the base project files (pom.xml, Dockerfiles, ...) are already generated by the base codestarts provided by the Quarkus core. Thanks to this, we can only focus on the starter code specific to the extension. Let's take `io.quarkiverse.aloha:quarkus-aloha` as an example extension GAV (don't look for this extension, it doesn't exist). @@ -148,7 +150,7 @@ metadata: artifact: "io.quarkiverse.aloha:quarkus-aloha:codestarts:jar:${project.version}" ---- -* Add the readme <> section template in `base/readme.tpl.qute.md`: +* Add the readme <> section template in `base/README.tpl.qute.md`: + [source,html] ---- @@ -157,11 +159,11 @@ metadata: * Run `mvn clean install` in the extension root (or just `runtime`). -* Now we can check that the codestart actually works by creating a project consuming our extension: +* Now we can check that the codestart actually works by creating a project consuming our extension (make sure the snapshot version is correct): + [source,bash] ---- -quarkus create app aloha-app x=io.quarkiverse.aloha:quarkus-aloha:999-SNAPSHOT +quarkus create app aloha-app -x=io.quarkiverse.aloha:quarkus-aloha:999-SNAPSHOT ... applying codestarts... @@ -353,7 +355,7 @@ Those templates are able to use data which contains: You may add a `README.md` or `README.tpl.qute.md` in the `base` directory, it will be appended to the others. So just add the info relative to your extension codestart. -base/readme.tpl.qute.md +base/README.tpl.qute.md [source,html] ---- {#include readme-header /}