Working group: Extract and display additional metadata

Extract deliverable, point of contact and discussion from the WG README.

Extend the working group page to add these new metadata

Improve the completed working group visualization and add link to the deliverable.

Author: cescoffier

_data/wg.yaml

@@ -1,5 +1,37 @@
 ---
 working-groups:
+    - title: "Roq :: Quarkus SSG"
+      board-url: "https://github.com/orgs/quarkiverse/projects/6"
+      short-description: Allow Static Site Generation with Quarkus.
+      readme: |
+        <p>New initiative to allow Static Site Generation with Quarkus.</p>
+        <p>Quarkus already provides most of the pieces to create great web applications (https://quarkus.io/guides/web).</p>
+        <p>I recently added https://github.com/quarkiverse/quarkus-roq. It will allow generating a static website out of any Quarkus application (it starts the app, fetch all the configured pages and assets, generate a static website and stop), it already works but it is still very alpha.</p>
+        <p>What's missing? we now need to incrementally add the toolkit to ease the process of creating static content through Quarkus:</p>
+        <ul>
+        <li>Static Data</li>
+        <li>Markdown/Asciidoc and frontmatter</li>
+        <li>SEO</li>
+        <li>Image processing</li>
+        <li>Easy to configure routing</li>
+        </ul>
+        <p>This will allow to develop the content using Quarkus dev-mode, and then generate for Github Pages or similar when it's ready.</p>
+        <p>Bonus, everything added will benefit any &quot;non-static&quot; Quarkus app and any Static Quarkus app could also become non static.</p>
+        <p>This effort is now tracked using a &quot;Working Group&quot; project: https://github.com/orgs/quarkiverse/projects/6</p>
+        <p>This is a great opportunity to participate in fun effort and be involved with the Quarkus community, if anyone is interested in being a part of this, please reach out to me 🚀</p>
+        <ul>
+        <li>Point of contact: @ia3andy</li>
+        <li>Discussion: https://github.com/quarkusio/quarkus/discussions/41309</li>
+        <li>Deliverable: <a href="https://www.youtube.com/live/hrF1a5sKqBI">Quarkus Insight</a></li>
+        </ul>
+      status: complete
+      completed: true
+      last-activity: 2024-11-18
+      last-update: |
+        ROQ has been released! See https://www.youtube.com/live/hrF1a5sKqBI to see ROQ in action.
+      deliverable: <a rel="nofollow" href="https://www.youtube.com/live/hrF1a5sKqBI">Quarkus Insight</a>
+      point-of-contact: "@ia3andy"
+      discussion: https://github.com/quarkusio/quarkus/discussions/41309
     - title: "WebSocket Next"
       board-url: "https://github.com/orgs/quarkusio/projects/26"
       short-description: WebSocket-Next related tasks
@@ -8,6 +40,7 @@ working-groups:
         <p>Recently, we delivered a new approach to dealing with WebSocket (both for the server and client). This was the first step. There are still a few areas to improve, such as documentation, security, observability, and testability. The goal of this focus group is to track these efforts.</p>
         <ul>
         <li>Point of contact: @mkouba (@<strong>Martin Kouba</strong>  on Zulip)</li>
+        <li>Discussion: https://github.com/quarkusio/quarkus/discussions/38473</li>
         </ul>
       status: on track
       completed: false
@@ -21,6 +54,8 @@ working-groups:
         The CDI request context is only activated if needed: https://github.com/quarkusio/quarkus/pull/43915.
         
         I hope that WS Next will be feature-complete at the time of 3.17 release.
+      point-of-contact: "@mkouba (@<strong>Martin Kouba</strong>  on Zulip)"
+      discussion: https://github.com/quarkusio/quarkus/discussions/38473
     - title: "Enhanced TLS support"
       board-url: "https://github.com/orgs/quarkusio/projects/24"
       short-description: Track the progress around the new TLS configuration centralization and new features (like Let's Encrypt, Cert-Manager, and local experience...)
@@ -40,6 +75,9 @@ working-groups:
         This working group is complete! 
         That does not mean that no work will be done around TLS, but what was defined in the initial scope of the working group has been completed. 
         Enhancements and bug fixes will follow.
+      deliverable: <a rel="nofollow" href="https://www.youtube.com/watch?v=VP7c9ftFwrQ">Quarkus Insight</a>
+      point-of-contact: "@cescoffier (@<strong>Clement Escoffier</strong> on Zulip)"
+      discussion: https://github.com/quarkusio/quarkus/discussions/41024
     - title: "Quarkus 3.15 LTS"
       board-url: "https://github.com/orgs/quarkusio/projects/28"
       short-description: This WG focuses on defining the issues we would like to have in the next-to-be LTS (Quarkus 3.14/3.15)
@@ -103,36 +141,6 @@ working-groups:
         
         With more features to be added in future pull requests.
         The pull request is on hold due to some concerns raised by @ia3andy. A meeting has been scheduled to discuss those concerns.
-    - title: "Roq :: Quarkus SSG"
-      board-url: "https://github.com/orgs/quarkiverse/projects/6"
-      short-description: Allow Static Site Generation with Quarkus.
-      readme: |
-        <p>New initiative to allow Static Site Generation with Quarkus.</p>
-        <p>Quarkus already provides most of the pieces to create great web applications (https://quarkus.io/guides/web).</p>
-        <p>I recently added https://github.com/quarkiverse/quarkus-roq. It will allow generating a static website out of any Quarkus application (it starts the app, fetch all the configured pages and assets, generate a static website and stop), it already works but it is still very alpha.</p>
-        <p>What's missing? we now need to incrementally add the toolkit to ease the process of creating static content through Quarkus:</p>
-        <ul>
-        <li>Static Data</li>
-        <li>Markdown/Asciidoc and frontmatter</li>
-        <li>SEO</li>
-        <li>Image processing</li>
-        <li>Easy to configure routing</li>
-        </ul>
-        <p>This will allow to develop the content using Quarkus dev-mode, and then generate for Github Pages or similar when it's ready.</p>
-        <p>Bonus, everything added will benefit any &quot;non-static&quot; Quarkus app and any Static Quarkus app could also become non static.</p>
-        <p>This effort is now tracked using a &quot;Working Group&quot; project: https://github.com/orgs/quarkiverse/projects/6</p>
-        <p>This is a great opportunity to participate in fun effort and be involved with the Quarkus community, if anyone is interested in being a part of this, please reach out to me 🚀</p>
-      status: staled
-      completed: false
-      last-activity: 2024-10-30
-      last-update: |
-        0.0.3 has been released, it is the MVP version and allowed to publish the Roq blog: https://quarkiverse.io/quarkus-roq/posts/2024-08-29-welcome-to-roq/
-        
-        From now on, we start adding features incrementally, documenting.
-        
-        The target is to have 1.0.0 the 1 October 2024.
-        
-        For 1.0 we need pagination, tags and SEO.
     - title: "Quarkus to the CommonHaus Foundation"
       board-url: "https://github.com/orgs/quarkusio/projects/38"
       short-description: Work needed around moving Quarkus to foundation and streamline open governance.

_includes/working-group-band.html

@@ -18,8 +18,14 @@
         <p class="card-text"><span class="key">Status:</span>&nbsp;<span class="status {{ item.status | | replace: ' ', '-'}}">{{ item.status }}</span></p>
         <p class="card-text"><span class="key">Description:</span>&nbsp;<span class="short-description">{{ item.short-description }}</span></p>
         <p class="card-text"><span class="key">Last Activity:</span>&nbsp;<span class="last-activity">{{ item.last-activity | date: '%B %d, %Y' }} </span></p>        
+        {% if item.point-of-contact %}
+        <p class="card-text"><span class="key">Point of Contact:</span>&nbsp;<span class="point-of-contact">{{ item.point-of-contact }}</span></p>
+        {% endif %}
+        {% if item.discussion %} 
+        <p class="card-text"><span class="key">Discussion:</span>&nbsp;<a class="discussion" href="{{ item.discussion }}">Link</a></p>
+        {% endif %}
       </div>
-      <div class="card-footer">       
+      <div class="card-footer">      
         <a href="{{ item.board-url }}" class="float-end"> View the {{ item.title }} Board <i class="fa-solid fa-chevron-right"></i></a>
       </div>
     </div>
@@ -31,16 +37,27 @@ <h2>Completed working groups</h2>
   <p class="mt-0">
     These working groups have completed their work and are no longer active:
   </p>
-  <ul>
-    {% for item in site.data.wg.working-groups %}
+  <div class="grid-wrapper working-groups-cards">
+    {% for item in site.data.wg.working-groups %}    
     {% if item.completed %}
-    <li>
-      <a href="{{ item.board-url }}">{{ item.title }} ({{ item.last-activity | date: '%B %d, %Y' }})</a>
-    </li>
+    <div class="card card-completed">
+      <div class="card-header">
+        <p class="card-title">{{ item.title }}</p>
+      </div>
+      <div class="card-body">
+        <p class="card-text"><span class="key">Description:</span>&nbsp;<span class="short-description">{{ item.short-description }}</span></p>
+        <p class="card-text"><span class="key">Completed on:</span>&nbsp;<span class="last-activity">{{ item.last-activity | date: '%B %d, %Y' }} </span></p>        
+        {% if item.deliverable %}
+        <p class="card-text"><span class="key">Deliverable:</span>&nbsp;<span class="deliverable">{{ item.deliverable }}</span></p>
+        {% endif %}       
+      </div>
+      <div class="card-footer">      
+        <a href="{{ item.board-url }}" class="float-end"> View the {{ item.title }} Board <i class="fa-solid fa-chevron-right"></i></a>
+      </div>
+    </div>
     {% endif %}
     {% endfor %}
-  </ul>
-
+    </div>
 
 </div>
 

_sass/layouts/working-groups.scss

@@ -32,7 +32,11 @@
 
   .card-body {
     padding: 1rem 0rem;
-    height: 11rem;
+    height: 15rem;
+  }
+
+  .card-completed {
+    background: WhiteSmoke;
   }
 
   .card-footer {

working-groups/main.java

@@ -5,7 +5,7 @@
 //DEPS io.quarkus:quarkus-picocli
 //DEPS io.quarkus:quarkus-smallrye-graphql-client
 //DEPS io.quarkus:quarkus-qute
-//DEPS org.commonmark:commonmark:0.22.0
+//DEPS org.commonmark:commonmark:0.23.0
 //DEPS io.quarkus:quarkus-config-yaml
 //FILES templates/=templates/*
 //FILES application.yaml
@@ -26,6 +26,7 @@
 import java.util.concurrent.ExecutionException;
 
 import org.commonmark.node.Node;
+import org.commonmark.node.Paragraph;
 import org.commonmark.parser.Parser;
 import org.commonmark.renderer.html.HtmlRenderer;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
@@ -198,6 +199,71 @@ public String getReadme() {
             return renderer.render(document);
         }
 
+        private static boolean isMetadata(String singular, String plural, String line) {
+            var l = line.toLowerCase().trim();
+            return l.startsWith("* " + singular.toLowerCase() + ":") 
+                || l.startsWith("* " + plural.toLowerCase() + ":");
+        }
+
+        public String getDeliverable() {
+            String line = longDescription().lines()
+                .filter(s -> isMetadata("Deliverable", "Deliverables", s))
+                .findFirst()
+                .orElse(null);
+                
+            if (line != null) {
+                var content = line.substring(line.indexOf(":") + 1).trim();
+                Parser parser = Parser.builder().build();
+                Node document = parser.parse(content);        
+                HtmlRenderer renderer = HtmlRenderer.builder()
+                    .omitSingleParagraphP(true)
+                    .escapeHtml(false)
+                    .sanitizeUrls(true)
+                .build();
+                return renderer.render(document);
+            }   
+
+            return null;
+        }
+
+        public String getPointOfContact() {
+            String line = longDescription().lines()
+                .filter(s -> isMetadata("Point of contact", "Points of contact", s))            
+                .findFirst()
+                .orElse(null);
+                
+            if (line != null) {
+                var content = line.substring(line.indexOf(":") + 1).trim();
+                Parser parser = Parser.builder().build();
+                Node document = parser.parse(content);                
+                HtmlRenderer renderer = HtmlRenderer.builder()
+                    .omitSingleParagraphP(true)
+                    .build();
+                return renderer.render(document);
+            }   
+
+            return null;
+        }
+
+        public String getDiscussionLink() {
+            String line = longDescription().lines()
+            .filter(s -> isMetadata("Discussion", "Discussions", s))
+            .findFirst()
+            .orElse(null);
+            
+        if (line != null) {
+            var content = line.substring(line.indexOf(":") + 1).trim();
+            Parser parser = Parser.builder().build();
+            Node document = parser.parse(content);        
+            HtmlRenderer renderer = HtmlRenderer.builder()
+                .omitSingleParagraphP(true)
+                .build();
+            return renderer.render(document);
+        }   
+
+        return null;
+        }
+
         public String getIndentedReadme() {
             String readme = getReadme();
             return readme.replaceAll("\n", "\n        ").trim();

working-groups/templates/wg.yaml.template

@@ -13,4 +13,13 @@ working-groups:
       last-update: |
         {board.getIndentedLastUpdate().raw}
       {/if}
+      {#if board.getDeliverable()}
+      deliverable: {board.getDeliverable().raw}
+      {/if}
+      {#if board.getPointOfContact()}
+      point-of-contact: "{board.getPointOfContact().raw}"
+      {/if}
+      {#if board.getDiscussionLink()}
+      discussion: {board.getDiscussionLink().raw}
+      {/if}
   {/for}