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

@@ -29,6 +29,9 @@ working-groups:
       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
@@ -51,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...)
@@ -70,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)

_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}