Merge pull request quarkusio#14797 from ia3andy/reduce-codestart-coup…

…ling
mkouba · Feb 8, 2021 · 0dd5182 · 0dd5182
2 parents 4155282 + 4d71614
commit 0dd5182
Show file tree

Hide file tree

Showing 73 changed files with 454 additions and 649 deletions.
diff --git a/...n/resources/codestarts/quarkus/core/examples/commandmode-example/base/README.md b/...n/resources/codestarts/quarkus/core/examples/commandmode-example/base/README.md
diff --git a/...es/codestarts/quarkus/core/examples/commandmode-example/base/README.tpl.qute.md b/...es/codestarts/quarkus/core/examples/commandmode-example/base/README.tpl.qute.md
@@ -0,0 +1 @@
+{#include readme-header /}
diff --git a/...son/src/main/resources/codestarts/quarkus/core/examples/commandmode-example/codestart.yml b/...son/src/main/resources/codestarts/quarkus/core/examples/commandmode-example/codestart.yml
@@ -2,6 +2,9 @@ name: commandmode-example
 ref: commandmode
 type: code
 tags: example
+metadata:
+  title: Command Mode example
+  description: Go go commando with this command mode main class.
 language:
   base:
     data:

diff --git a/...urces/codestarts/quarkus/core/examples/resteasy-example/base/README.tpl.qute.md b/...urces/codestarts/quarkus/core/examples/resteasy-example/base/README.tpl.qute.md
@@ -1,4 +1 @@
-# {title}
-
-{description}
-Guide: {guide}
+{#include readme-header /}
diff --git a/...xamples/resteasy-example/base/src/main/resources/META-INF/resources/index.entry.qute.html b/...xamples/resteasy-example/base/src/main/resources/META-INF/resources/index.entry.qute.html
@@ -0,0 +1 @@
+{#include index-entry path=resource.path/}
diff --git a/.../examples/resteasy-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html b/.../examples/resteasy-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html
diff --git a/...r-json/src/main/resources/codestarts/quarkus/core/examples/resteasy-example/codestart.yml b/...r-json/src/main/resources/codestarts/quarkus/core/examples/resteasy-example/codestart.yml
@@ -2,17 +2,17 @@ name: resteasy-example
 ref: resteasy
 type: code
 tags: example
+metadata:
+  title: RESTEasy JAX-RS example
+  description: REST is easy peasy with this Hello World RESTEasy resource.
+  related-guide-section: https://quarkus.io/guides/getting-started#the-jax-rs-resources
 language:
   base:
     data:
-      title: RESTEasy JAX-RS
-      description: |
-        <p>A Hello World RESTEasy resource</p>
       resource:
         class-name: GreetingResource
         path: "/hello-resteasy"
         response: "Hello RESTEasy"
-      guide: https://quarkus.io/guides/rest-json
     dependencies:
       - io.quarkus:quarkus-resteasy
     test-dependencies:

diff --git a/...estarts/quarkus/core/examples/resteasy-reactive-example/base/README.tpl.qute.md b/...estarts/quarkus/core/examples/resteasy-reactive-example/base/README.tpl.qute.md
@@ -1,4 +1 @@
-# {title}
-
-{description}
-Guide: {guide}
+{#include readme-header /}
diff --git a/...esteasy-reactive-example/base/src/main/resources/META-INF/resources/index.entry.qute.html b/...esteasy-reactive-example/base/src/main/resources/META-INF/resources/index.entry.qute.html
@@ -0,0 +1 @@
+{#include index-entry path=resource.path/}
diff --git a/.../resteasy-reactive-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html b/.../resteasy-reactive-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html
diff --git a/...c/main/resources/codestarts/quarkus/core/examples/resteasy-reactive-example/codestart.yml b/...c/main/resources/codestarts/quarkus/core/examples/resteasy-reactive-example/codestart.yml
@@ -2,17 +2,17 @@ name: resteasy-reactive-example
 ref: resteasy-reactive
 type: code
 tags: example
+metadata:
+  title: RESTEasy Reactive example
+  description: Rest is easy peasy & reactive with this Hello World RESTEasy Reactive resource.
+  related-guide-section: https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources
 language:
   base:
     data:
-      title: RESTEasy Reactive
-      description: |
-        <p>A Hello World RESTEasy Reactive resource</p>
       resource:
         class-name: ReactiveGreetingResource
         path: "/hello-resteasy-reactive"
         response: "Hello RESTEasy Reactive"
-      guide: https://quarkus.io/guides/getting-started-reactive
     dependencies:
       - io.quarkus:quarkus-resteasy-reactive
     test-dependencies:

diff --git a/...ces/codestarts/quarkus/core/examples/spring-web-example/base/README.tpl.qute.md b/...ces/codestarts/quarkus/core/examples/spring-web-example/base/README.tpl.qute.md
@@ -1,4 +1 @@
-# {title}
-
-{description}
-Guide: {guide}
+{#include readme-header /}
diff --git a/...mples/spring-web-example/base/src/main/resources/META-INF/resources/index.entry.qute.html b/...mples/spring-web-example/base/src/main/resources/META-INF/resources/index.entry.qute.html
@@ -0,0 +1 @@
+{#include index-entry path=resource.path/}
diff --git a/...xamples/spring-web-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html b/...xamples/spring-web-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html
diff --git a/...json/src/main/resources/codestarts/quarkus/core/examples/spring-web-example/codestart.yml b/...json/src/main/resources/codestarts/quarkus/core/examples/spring-web-example/codestart.yml
@@ -2,18 +2,18 @@ name: spring-web-example
 ref: spring-web
 type: code
 tags: example
+metadata:
+  title: Spring Web example
+  description: Spring, the Quarkus way! A Hello World Spring Web Controller.
+  related-guide-section: https://quarkus.io/guides/spring-web#greetingcontroller
 language:
   base:
     data:
-      title: Spring Web
-      description: |
-        <p>A Hello World Spring Web Controller</p>
       resource:
         class-name: SpringGreetingController
         path: "/hello-spring"
         response: "Hello Spring"
       package-name: org.acme
-      guide: https://quarkus.io/guides/spring-web
     dependencies:
       - io.quarkus:quarkus-spring-web
     test-dependencies:

diff --git a/.../main/resources/codestarts/quarkus/core/project/quarkus/base/README.tpl.qute.md b/.../main/resources/codestarts/quarkus/core/project/quarkus/base/README.tpl.qute.md
@@ -11,6 +11,8 @@ You can run your application in dev mode that enables live coding using:
 {buildtool.cli} {buildtool.cmd.dev}
 ```
 
+> **_NOTE:_**  Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
+
 ## Packaging and running the application
 
 The application can be packaged using:
@@ -43,3 +45,17 @@ You can then execute your native executable with: `./{buildtool.build-dir}/{proj
 
 If you want to learn more about building native executables, please consult {buildtool.guide}.
 
+{#if selected-extensions}
+## Related guides
+
+{#for ext in selected-extensions}
+{#if ext.guide}
+- {ext.name} ([guide]({ext.guide})): {ext.description}
+{/if}
+{/for}
+
+{/if}
+{#if selected-examples}
+## Provided examples
+{/if}
+
diff --git a/.../src/main/resources/codestarts/quarkus/core/project/quarkus/base/index-entry.include.qute b/.../src/main/resources/codestarts/quarkus/core/project/quarkus/base/index-entry.include.qute
@@ -0,0 +1,7 @@
+        <div class="example-code">
+            <h3>{title}</h3>
+            <p>{description}</p>
+            {#if path}<p><code>@Path: <a href="{path}" class="path-link" target="_blank">{path}</a></code></p>{/if}
+            {#if related-guide-section}<p><a href="{related-guide-section}" class="guide-link" target="_blank">Related guide section...</a></p>{/if}
+            {#insert body}{/}
+        </div>
diff --git a/...rc/main/resources/codestarts/quarkus/core/project/quarkus/base/readme-header.include.qute b/...rc/main/resources/codestarts/quarkus/core/project/quarkus/base/readme-header.include.qute
@@ -0,0 +1,7 @@
+### {title}
+
+{description}
+{#if related-guide-section}
+
+[Related guide section...]({related-guide-section})
+{/if}
diff --git a/...arkus/core/project/quarkus/base/src/main/resources/META-INF/resources/index.tpl.qute.html b/...arkus/core/project/quarkus/base/src/main/resources/META-INF/resources/index.tpl.qute.html
@@ -20,6 +20,7 @@
 
         h3 {
             font-size: 1.75rem
+
         }
 
         h4 {
@@ -95,82 +96,13 @@
             padding-left: 0;
         }
 
-        .examples {
-            display: flex;
-            flex-wrap: wrap;
-            margin: 20px 0 20px -40px;
-        }
-
-        .example {
-            display: flex;
-            margin-left: 20px;
-            margin-bottom: 20px;
-            flex-direction: column;
-            width: 350px;
-            background-color: #205894;
-            color: white;
-        }
-
-        .example code {
-            color: lightgrey;
-        }
-
-        .example-header {
-            padding: 20px;
-            display: flex;
-            position: relative;
-        }
-
-        .example-header h4 {
-            margin: 0;
-            font-size: 1.4rem;
-            flex-grow: 1;
-            line-height: 1.5;
-        }
-
-        .example-description {
-            padding: 0 20px;
-            flex-grow: 1;
-        }
-
-        .example-paths {
-            display: flex;
-            flex-direction: column;
-        }
-
-        .example-paths a {
-            display: block;
-            background-color: transparent;
-            font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
-            color: white;
-            padding: 10px;
-            text-decoration: none;
-        }
-
-        .example-paths a:before {
-            content: '⇨';
-            font-weight: bold;
-            font-size: 1.5rem;
-            margin: 20px;
-        }
-
-        .example-paths a:hover {
-            background-color: #0d1c2c;
-        }
-
-        .guide-link {
-            background-color: #71aeef;
-            position: absolute;
-            color: white;
-            text-decoration: none;
-            top: 0;
-            right: 0;
-            padding: 7px;
-            font-weight: bold;
+        .example-code {
+            border-left: 0.3rem solid #71aeef;
+            padding-left: 10px;
         }
 
-        .guide-link:hover {
-            background-color: #0d1c2c;
+        .example-code h3 {
+            font-weight: 200;
         }
     </style>
 </head>
@@ -184,42 +116,57 @@
     <div class="left-column">
         <p class="lead"> Congratulations, you have created a new Quarkus cloud application.</p>
 
-        <h2>Why do you see this?</h2>
+        <h2>What is this page?</h2>
 
         <p>This page is served by Quarkus. The source is in
             <code>src/main/resources/META-INF/resources/index.html</code>.</p>
 
-        <h2>What can I do from here?</h2>
+        <h2>What are your next steps?</h2>
 
         <p>If not already done, run the application in <em>dev mode</em> using: <code>{buildtool.cli} {buildtool.cmd.dev}</code>.
         </p>
         <ul>
-            <li>Play with your example code in <code>{language.dir.code}</code>:
-                <div class="examples">
-{merged-content}
-                </div>
-            </li>
             <li>Your static assets are located in <code>src/main/resources/META-INF/resources</code>.</li>
             <li>Configure your application in <code>src/main/resources/{config.file-name}</code>.</li>
+            <li>Quarkus now ships with a <a href="/q/dev/">Dev UI</a> (available in dev mode only)</li>
+            <li>Play with the getting started example code located in <code>{language.dir.code}</code>:</li>
         </ul>
-        <h2>Do you like Quarkus?</h2>
-        <p>Go give it a star on <a href="https://github.com/quarkusio/quarkus">GitHub</a>.</p>
+        {merged-content}
     </div>
     <div class="right-column">
         <div class="right-section">
             <h3>Application</h3>
             <ul>
-                <li>GroupId: {project.group-id}</li>
-                <li>ArtifactId: {project.artifact-id}</li>
-                <li>Version: {project.version}</li>
-                <li>Quarkus Version: {quarkus.version}</li>
+                <li>GroupId: <code>{project.group-id}</code></li>
+                <li>ArtifactId: <code>{project.artifact-id}</code></li>
+                <li>Version: <code>{project.version}</code></li>
+                <li>Quarkus Version: <code>{quarkus.version}</code></li>
+            </ul>
+        </div>
+        <div class="right-section">
+            <h3>Do you like Quarkus?</h3>
+            <ul>
+                <li>Go give it a star on <a href="https://github.com/quarkusio/quarkus">GitHub</a>.</li>
+            </ul>
+        </div>
+        {#if selected-extensions}
+        <div class="right-section">
+            <h3>Selected extensions guides</h3>
+            <ul>
+                {#for ext in selected-extensions}
+                {#if ext.guide}
+                <li title="{ext.description}"><a href="{ext.guide}" target="_blank">{ext.name} guide</a></li>
+                {/if}
+                {/for}
             </ul>
         </div>
+        {/if}
         <div class="right-section">
-            <h3>Next steps</h3>
+            <h3>More reading</h3>
             <ul>
                 <li><a href="{buildtool.guide}" target="_blank">Setup your IDE</a></li>
                 <li><a href="https://quarkus.io/guides/getting-started.html" target="_blank">Getting started</a></li>
+                <li><a href="https://quarkus.io/guides/" target="_blank">All guides</a></li>
                 <li><a href="https://quarkus.io" target="_blank">Quarkus Web Site</a></li>
             </ul>
         </div>

diff --git a/...in/resources/codestarts/quarkus/examples/config-example/base/README.tpl.qute.md b/...in/resources/codestarts/quarkus/examples/config-example/base/README.tpl.qute.md
@@ -1,6 +1,3 @@
-# {title}
+{#include readme-header /}
 
-<p>This example displays mach speed in your favourite unit, depending on the specified Quarkus configuration.</p>
-<p>The Quarkus configuration is located in: <code>src/main/resources/{config.file-name}</code></p>
-<p><b>Supersonic!</b></p>
-Guide: {config.guide}
+The Quarkus configuration location is `src/main/resources/{config.file-name}`.
diff --git a/.../examples/config-example/base/src/main/resources/META-INF/resources/index.entry.qute.html b/.../examples/config-example/base/src/main/resources/META-INF/resources/index.entry.qute.html
@@ -0,0 +1 @@
+{#include index-entry /}
diff --git a/...us/examples/config-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html b/...us/examples/config-example/base/src/main/resources/META-INF/resources/index.tpl.qute.html