Merge pull request #2281 from jasondlee/roq

Migrate from Jekyll to Roq

Author: darranl

.dockerignore

@@ -0,0 +1,5 @@
+*
+!target/*-runner
+!target/*-runner.jar
+!target/lib/*
+!target/quarkus-app/*

.github/workflows/roq.yml

@@ -0,0 +1,29 @@
+name: Roq Site Deploy
+
+on:
+  push:
+    branches: [ develop ]   # Switch to the branch which should be deployed to GitHub Pages
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Generate Roq Site
+        uses: quarkiverse/quarkus-roq@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}   # Used to automatically get the GitHub Pages url
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,10 +1,45 @@
+#Maven
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+release.properties
+.flattened-pom.xml
+
+# Eclipse
 .project
+.classpath
+.settings/
+bin/
+
+# IntelliJ
 .idea
+*.ipr
+*.iml
+*.iws
+
+# NetBeans
+nb-configuration.xml
+
+# Visual Studio Code
 .vscode
-target
-_site
-vendor/
-.sass-cache
-.jekyll-cache
-.jekyll-metadata
-Gemfile.lock
+.factorypath
+
+# OSX
+.DS_Store
+
+# Vim
+*.swp
+*.swo
+
+# patch
+*.orig
+*.rej
+
+# Local environment
+.env
+
+# Plugin directory
+/.quarkus/cli/plugins/
+# TLS Certificates
+.certs/

.mvn/wrapper/.gitignore

@@ -0,0 +1 @@
+maven-wrapper.jar

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,93 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.Authenticator;
+import java.net.PasswordAuthentication;
+import java.net.URI;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.concurrent.ThreadLocalRandom;
+
+public final class MavenWrapperDownloader {
+    private static final String WRAPPER_VERSION = "3.3.2";
+
+    private static final boolean VERBOSE = Boolean.parseBoolean(System.getenv("MVNW_VERBOSE"));
+
+    public static void main(String[] args) {
+        log("Apache Maven Wrapper Downloader " + WRAPPER_VERSION);
+
+        if (args.length != 2) {
+            System.err.println(" - ERROR wrapperUrl or wrapperJarPath parameter missing");
+            System.exit(1);
+        }
+
+        try {
+            log(" - Downloader started");
+            final URL wrapperUrl = URI.create(args[0]).toURL();
+            final String jarPath = args[1].replace("..", ""); // Sanitize path
+            final Path wrapperJarPath = Paths.get(jarPath).toAbsolutePath().normalize();
+            downloadFileFromURL(wrapperUrl, wrapperJarPath);
+            log("Done");
+        } catch (IOException e) {
+            System.err.println("- Error downloading: " + e.getMessage());
+            if (VERBOSE) {
+                e.printStackTrace();
+            }
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(URL wrapperUrl, Path wrapperJarPath)
+            throws IOException {
+        log(" - Downloading to: " + wrapperJarPath);
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            final String username = System.getenv("MVNW_USERNAME");
+            final char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        Path temp = wrapperJarPath
+                .getParent()
+                .resolve(wrapperJarPath.getFileName() + "."
+                        + Long.toUnsignedString(ThreadLocalRandom.current().nextLong()) + ".tmp");
+        try (InputStream inStream = wrapperUrl.openStream()) {
+            Files.copy(inStream, temp, StandardCopyOption.REPLACE_EXISTING);
+            Files.move(temp, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING);
+        } finally {
+            Files.deleteIfExists(temp);
+        }
+        log(" - Downloader complete");
+    }
+
+    private static void log(String msg) {
+        if (VERBOSE) {
+            System.out.println(msg);
+        }
+    }
+
+}

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=source
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar

.ruby-version

@@ -5,61 +5,62 @@
 These instructions will allow you to run the Elytron website locally for development and testing purposes.
 
 ### Installation
-The following steps are based on the [Jekyll static site generator docs](https://jekyllrb.com/docs/).
+The following steps are based on the [Roq static site generator docs](https://iamroq.com/docs/getting-started/).
 
-1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/)
-2. Install jekyll and [bundler](https://jekyllrb.com/docs/ruby-101/#bundler)  [gems](https://jekyllrb.com/docs/ruby-101/#gems) 
-  
-        gem install jekyll bundler
+1. Install a full Java development environment. For example, using [SDKMAN!](https://sdkman.io/)
+
+       $curl -s "https://get.sdkman.io" | bash
+       ...
+       $ sdk install java 24-tem
+       ...
+       $ sdk install maven 3.9.9
+       ...
+       $ sdk install quarkus # This is optional
+
+2. Fork the [project repository](https://github.com/wildfly-security/wildfly-elytron), then clone your fork.
 
-3. Fork the [project repository](https://github.com/wildfly-security/wildfly-elytron), then clone your fork.
-  
         git clone git@github.com:YOUR_USER_NAME/wildfly-elytron.git
 
-4. Change into the project directory:
-  
+3. Change into the project directory:
+
         cd wildfly-elytron
 
-5. Checkout the [develop](https://github.com/wildfly-security/wildfly-elytron/tree/develop) branch:
-  
+4. Check out the [develop](https://github.com/wildfly-security/wildfly-elytron/tree/develop) branch:
+
         git checkout develop
 
-6. Use bundler to fetch all required gems in their respective versions
+5. Build the site and make it available on a local server
+
+        mvn quarkus:dev
 
-        bundle install
+    or
 
-7. Build the site and make it available on a local server
-  
-        bundle exec jekyll serve
+        quarkus dev
 
-   If you encounter the following message:
+6. Now browse to http://localhost:8080/wildfly-elytron/
 
-        FATAL: Listen error: unable to monitor directories for changes.  
-        
-   Please refer to these [instructions](https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers) to fix this.       
-        
-8. Now browse to http://localhost:4000/wildfly-elytron/
+7. Optionally, to just build the static files:
 
-> If you encounter any unexpected errors during the above, please refer to the [troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems) page or the [requirements](https://jekyllrb.com/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
+        QUARKUS_ROQ_GENERATOR_BATCH=true mvn package quarkus:run
 
+   The files will available under `target/roq`.
 
-**For more regarding the use of Jekyll, please refer to the [Jekyll Step by Step Tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/).**
 
 ## Writing a blog post
 
 To write a blog post:
 
-1. Add an author entry in [_data/authors.yaml](https://github.com/wildfly-security/wildfly-elytron/tree/develop/_data/authors.yaml)
+1. Add an author entry in [data/authors.yaml](https://github.com/wildfly-security/wildfly-elytron/tree/develop/data/authors.yaml)
     - Your profile picture is fetched from [the Gravatar service](https://gravatar.com/). Create an account,
-      and then associate your email with the account. Validate your picture with [the email checker](https://gravatar.com/site/check/). 
+      and then associate your email with the account. Validate your picture with [the email checker](https://gravatar.com/site/check/).
       The field `emailhash` in authors.yaml is set using [these instructions](https://gravatar.com/site/implement/hash/),
       or with the output from the following command:
         ```bash
         echo -n 'email@address.com' | awk '{NF=1;printf "%s", tolower($1);}' | md5sum - | awk 'NF=1'
         ```
-2. Create a blog post entry under [_posts](https://github.com/wildfly-security/wildfly-elytron/tree/develop/_posts)
+2. Create a blog post entry under [content/blog](https://github.com/wildfly-security/wildfly-elytron/tree/develop/content/blog)
     - The file name should be `yyyy-mm-dd-slug.adoc`
-3. Your blog post should be in asciidoc format (take a look at other blogs posts in the _posts directory to see examples)
+3. Your blog post should be in asciidoc format (take a look at other blogs posts in the `content/blog` directory to see examples)
     - To view your blog post without needing to build locally, the following steps can be used:
         - If you haven't done so already, generate a fine-grained GitHub token following the instructions
           [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). Use this value to add a `PUSH_GITHUB_TOKEN` secret to your
@@ -76,6 +77,6 @@ To write a blog post:
                 git push origin gh-pages
                 ```
     - To view your blog post locally, first follow the instructions [above](https://github.com/wildfly-security/wildfly-elytron/tree/develop#installation) to build the Elytron website
-      locally. Then browse to http://localhost:4000/wildfly-elytron/blog and click on your post.
+      locally. Then browse to http://localhost:8080/wildfly-elytron/blog and click on your post.
 4. Submit a pull request against the `wildfly-elytron` `develop` branch