Skip to content

Commit

Permalink
Merge pull request wildfly#538 from jmesnil/main
Browse files Browse the repository at this point in the history
Publish the WildFly Proposals in https://docs.wildfly.org
  • Loading branch information
bstansberry authored Sep 29, 2023
2 parents 1e31338 + c36b29c commit 95c52d2
Show file tree
Hide file tree
Showing 377 changed files with 3,511 additions and 206 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/jekyll.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v2

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
_site
# ignore .svn metadata files
.svn
# ignore Maven generated target folders
Expand Down
12 changes: 12 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
source "https://rubygems.org"

gem "jekyll"
gem "minima"

group :jekyll_plugins do
gem "jekyll-feed"
gem "jekyll-seo-tag"
gem 'jekyll-asciidoc'
gem 'jekyll-paginate-v2'

end
93 changes: 93 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.5)
public_suffix (>= 2.0.2, < 6.0)
asciidoctor (2.0.20)
colorator (1.1.0)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
forwardable-extended (2.6.0)
google-protobuf (3.24.3-arm64-darwin)
google-protobuf (3.24.3-x86_64-linux)
http_parser.rb (0.8.0)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
jekyll (4.3.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-asciidoc (3.0.0)
asciidoctor (>= 1.5.0)
jekyll (>= 3.0.0)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-paginate-v2 (3.0.0)
jekyll (>= 3.0, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.3)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.1.3)
safe_yaml (1.0.5)
sass-embedded (1.66.1-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.66.1-x86_64-linux-gnu)
google-protobuf (~> 3.23)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
webrick (1.8.1)

PLATFORMS
arm64-darwin-22
x86_64-linux

DEPENDENCIES
jekyll
jekyll-asciidoc
jekyll-feed
jekyll-paginate-v2
jekyll-seo-tag
minima

BUNDLED WITH
2.4.19
29 changes: 29 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
title: WildFly Proposals
url: "https://docs.wildfly.org/"
baseurl: /wildfly-proposals
# Build settings
markdown: kramdown
theme: minima
plugins:
- jekyll-feed
- jekyll-paginate-v2
sass:
style: compressed

defaults:
- scope:
path: ""
values:
layout: "proposal"

collections:
docs:
output: true
wildfly-categories:
output: true

asciidoctor:
base_dir: :docdir
safe: unsafe
attributes:
imagesdir: /assets/img/news/
137 changes: 137 additions & 0 deletions _data/wildfly-categories.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
categories:
- name: Agroal
id: agroal
description: Agroal DataSources
- name: Bootable Jar
id: bootable-jar
description: WildFly and an application packaged as an executable jar
- name: Command Line Interface (CLI)
id: cli
description: Command Line Interface tool
- name: Cloud
id: cloud
description: Developing and Running a WildFly application on the cloud
- name: Clustering
id: clustering
description: Clustering, including Infinispan and JGroups
- name: Datasources
id: datasource
description: Server-provided `javax.sql.Datasource`s
- name: Embedded
id: embedded
description: Embedding WildFly in another process
- name: IIOP
id: iiop
description: Internet InterORB Protocol and CORBA
- name: Jakarta Batch
id: batch
description: Jakarta Batch
- name: Jakarta CDI / Weld
id: weld
description: Jakarta Contexts and Dependency Injection
- name: Jakarta Concurrency
id: concurrency
description: Jakarta Concurrency
- name: Jakarta Connectors
id: jca
description: Jakarta Connectors
- name: Jakarta EE
id: ee
description: Jakarta Enterprise Edition
- name: Jakarta Enterprise Beans
id: ejb
description: Jakarta Enterprise Beans (EJB)
- name: Jakarta Faces
id: jsf
description: Jakarta Faces
- name: Jakarta Mail
id: mail
description: Mail
- name: Jakarta Persistence
id: jpa
description: Jakarta Persistence
- name: Jakarta Resources
id: resource-adapter
description: Resource adapters
- name: Jakarta RESTful Web Services
id: jaxrs
description: Jakarta RESTful Web Services
- name: Jakarta Validation
id: bean-validation
description: Jakarta Validation
- name: JBoss Diagnostic Reporter
id: jdr
description: JBoss Diagnostic Reporter
- name: JBoss MSC
id: msc
description: JBoss Modular Service Container
- name: Logging
id: logging
description: Logging
- name: Management
id: management
description: Management
- name: Maven
id: maven
description: Maven Tooling & Ecosystem
- name: Messaging
id: messaging
description: Messaging, including Jakarta Messaging (JMS)
- name: MicroProfile
id: microprofile
description: MicroProfile
- name: Migration
id: migration
description: Application and server configuration migration
- name: Mod_cluster
id: mod_cluster
description: mod_cluster
- name: Modules
id: modules
description: JBoss Modules & Java Platform Module System (JPMS)
- name: Observability
id: observability
description: Observability
- name: OpenShift
id: openshift
description: Building and Running a WildFly application on OpenShift
- name: POJO
id: pojo
description: Legacy JBoss Microcontainer support
- name: Quickstarts
id: quickstarts
description: Quickstart examples for WildFly
- name: Scripts
id: scripts
description: Scripting WildFly
- name: Security
id: security
description: Security
- name: Service Archive (SAR)
id: sar
description: Service Archive (SAR)
- name: Transactions
id: transactions
description: Transactions, including Jakarta Transactions API (JTA, JTS)
- name: Undertow
id: undertow
description: Undertow
- name: User Experience
id: user-experience
description: Improving the experience of using WildFly
- name: Web Console
id: console
description: HAL Web Console
- name: Web Services
id: webservices
description: Web Services
- name: WildFly Core
id: core
description: WildFly Core
- name: WildFly Elytron
id: elytron
description: WildFly Elytron
- name: WildFly Galleon
id: wf-galleon
description: Provision WildFly with Galleon Feature Packs and Layers
51 changes: 51 additions & 0 deletions _includes/index-categories.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<div class="about-page home-section">
<h1 class="title"><strong>Wild</strong>Fly Proposals</h1>
<h2 class="page-subtitle">A central location for analysis and design documents of new features and capabilities in the <a href="https://wildfly.org">WildFly</a> project universe</h2>
<h2>WildFly features and capabilites are described as <em>proposals</em> documents that contain information on their context, scope, requirements, etc.
Proposals can affect one or many categories. This page lists all categories and their respective proposals.</h2>
</div>


<div class="categories">

<h2 class="sec-title-teal">Categories</h2>
<ul>
{% for cat in site.data["wildfly-categories"].categories %}
<li><a href="#{{ cat.id }}">{{ cat.name }}</a></li>
{% endfor %}
</ul>
<ul>
<li><a href="#uncategorized">Uncategorized Proposals</a></li>
</ul>

<hr />

<div>
{% for cat in site.data["wildfly-categories"].categories %}
<h2 id="{{ cat.id }}">{{ cat.name }} <small>[{{ cat.id }}]</small></a></h2>
<div class="description">{{ cat.description | markdownify }}</div>

{% for page in site.pages %}
<ul>
{% if page.categories contains cat.id %}
<li><a href="{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a></li>
{% endif %}
</ul>
{% endfor %}
{% endfor %}
</div>

<div>
<h2 id="uncategorized">Uncategorized Proposals</h2>

{% for page in site.pages %}
<ul>
{% unless page.categories %}
{% if page.title != nil and page.layout == "proposal" %}
<li><a href="{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a></li>
{% endif %}
{% endunless %}
</ul>
{% endfor %}
</div>
</div>
Loading

0 comments on commit 95c52d2

Please sign in to comment.