Merge pull request #2 from jotak/main

Switch to Quarkus Roq

Author: jotak

.github/workflows/static.yml

@@ -0,0 +1,65 @@
+## Deploy to GH-Pages for your Quarkus Roq blog.
+name: Quarkus Roq Deploy CI
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+env:
+  QUARKUS_ROQ_GENERATOR_BATCH: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Get GitHub Pages URL
+        id: get_url
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          url=$(gh api "repos/$GITHUB_REPOSITORY/pages" --jq '.html_url');echo "ghp-url=$url";
+          path=$(echo "$url" | sed -E 's|https?://[^/]+(/.*)?|\1|')
+          url=$(echo "$url" | sed -E 's|(https?://[^/]+).*|\1|')
+          if [ -z "$path" ]; then
+            path="/"
+          fi
+          echo "SITE_URL=$url"; echo "SITE_URL=$url" >> $GITHUB_ENV;
+          echo "SITE_PATH=$path"; echo "SITE_PATH=$path" >> $GITHUB_ENV;
+      - name: Build & Generate Blog
+        run: mvn -B package quarkus:run -DskipTests -Dquarkus.http.root-path=$SITE_PATH -Dsite.url=$SITE_URL
+      - name: Upload site as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: site
+          path: target/roq
+          retention-days: 1
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Download Built site
+        uses: actions/download-artifact@v4
+        with:
+          name: site
+          path: _site
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,3 @@
+data/*.json
+.quarkus
+target/

.gitmodules

@@ -1 +1,2 @@
-netobserv.io
+netobserv.io
+

404.md

@@ -1,8 +1,44 @@
-# Welcome to [netobserv.io](https://netobserv.io)
+# netobserv.io
 
-This site is under construction...
+This repository contains the code for the [netobserv.io](https://netobserv.io) web site / blog.
 
-All sources are available on [github.com/netobserv](https://github.com/netobserv)
-- Network Observability Operator [getting started guide](https://github.com/netobserv/network-observability-operator/blob/main/README.md)
-- Available [blog articles](./documents/blogs/index.md)
-- Extra [documents and hacks](./documents/README.md)
+## How it works
+
+It uses the static site generator [Quarkus Roq](https://pages.quarkiverse.io/quarkus-roq/) to generate a static HTML site based on markdown pages.
+
+Most of the time, writing content simply requires you to drop a new markdown file in [content/posts](./content/posts/), and assets (such as images) in [static/assets](./static/assets/). A few meta-data is also required at the top of the markdown file, such as:
+
+```
+---
+layout: :theme/post
+title: "Your post title"
+description: "The post description"
+tags: Insert,Some,Tags,Here
+authors: [your-name]
+---
+
+```
+
+Then, open a pull-request and the post will be reviewed by maintainers.
+
+First-time contributors should also provide some info about themselves in [data/authors.yml](./data/authors.yml).
+
+## Testing locally
+
+To test locally, the simplest way is to use the [quarkus CLI](https://quarkus.io/guides/cli-tooling).
+
+After you cloned this repository, from its root, run:
+
+```bash
+quarkus dev
+```
+
+And then open http://localhost:8080/
+
+## Deploying on netobserv.io
+
+Deploying on netobserv.io is fully automated after pull-requests are merged. This is all handled via [a github action](./.github/workflows/static.yml) that runs quarkus to generate the static HTML artifact, which is deployed through GitHub pages.
+
+## Contributions
+
+Like all the other NetObserv components, this blog is open-source and we are welcoming external contributions. Feel free to open pull-requests!

CNAME

@@ -0,0 +1,5 @@
+---
+layout: :theme/404
+link: 404.html
+image: iamroq.png
+---

README.md

@@ -0,0 +1,12 @@
+---
+title: About
+description: |
+  NetObserv aka Network Observability is a set of components used to observe network traffic by generating NetFlows from eBPF agents, enrich those flows using a configurable pipeline that is Kubernetes-aware, export them in various ways (logs, metrics, Kafka, IPFIX...), and finally provide a comprehensive visualization tool for making sense of that data, and a CLI. Those components can be used as standalones or deployed in Kubernetes / OpenShift via an integrated Operator.
+layout: :theme/page
+---
+
+# About NetObserv
+
+NetObserv is a set of components used to observe network traffic by generating NetFlows from [eBPF agents](https://github.com/netobserv/netobserv-ebpf-agent), enriching those flows using [a configurable pipeline](https://github.com/netobserv/flowlogs-pipeline/) which is Kubernetes-aware, exporting them in various ways (logs, metrics, Kafka, IPFIX...), and finally providing a comprehensive [visualization tool](https://github.com/netobserv/network-observability-console-plugin/) for making sense of that data, and [a CLI](https://github.com/netobserv/network-observability-cli). Those components can be used as standalones or deployed in Kubernetes / OpenShift via an [integrated Operator](https://github.com/netobserv/network-observability-operator/).
+
+It is known and distributed in Red Hat OpenShift as the [Network Observability operator](https://docs.openshift.com/container-platform/latest/observability/network_observability/network-observability-operator-release-notes.html).

content/404.html

@@ -0,0 +1,21 @@
+---
+title: Authors
+description: |
+  Authors on this blog.
+layout: :theme/page
+---
+
+# Authors on this blog
+
+<div class="authors">
+  <!-- authors.yml is in the data/ -->
+  {#for id in lists:shuffle(cdi:authors.fields)}
+    {#let author=cdi:authors.get(id)}
+    <!-- the author-card tag is defined in the default Roq theme -->
+    {#author-card name=author.name avatar=author.avatar nickname=author.nickname profile=author.profile}
+      {#if author.bio}
+        {author.bio}
+      {/if}
+    {/author-card}
+  {/for}
+</div>

content/about.md

@@ -0,0 +1,18 @@
+---
+title: Timeline
+description: NetObserv timeline
+layout: :theme/page
+---
+
+<h1>NetObserv timeline</h1>
+
+{#for event in cdi:events.list}
+<article class="event">
+  <div class="event-content">
+    <span class="post-date"><i class="fa fa-timeline"></i>{event.parsedDate.format('yyyy, MMM dd')}</span>
+    <h2 class="event-title">{event.title}</h2>
+    <p>{event.description}</p>
+    {#if event.link}<a href="{site.url.resolve(event.link)}">More info...</a>{/if}
+  </div>
+</article>
+{/for}