Switch Attic to new Jekyll Generated Website

.asf.yaml

@@ -23,6 +23,7 @@ github:
   labels:
     - apache
     - attic
+    - Jekyll
   features:
     # disable issues management: we're using Jira https://issues.apache.org/jira/projects/ATTIC/summary
     issues: false

.github/workflows/website.yml

@@ -37,10 +37,26 @@ jobs:
           ref: asf-site
           fetch-depth: 1
           path: asf-site
+      - name: 🗂 Checkout cwiki-retired branch with minimum depth
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9  # 3.5.3
+        with:
+          ref: cwiki-retired
+          fetch-depth: 1
+          path: cwiki-retired
+      - name: Set up Ruby
+        # Although ubuntu-latest includes ruby 3.2.2, this step is needed to set up bundler
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.3
+          bundler-cache: true
       - name: 🔧 Build site
         run: |
           rm -rf asf-site/output/*
-          ./build.sh -Ddocs.dest=asf-site/output
+          rm -rf cwiki-retired/*
+          ruby --version
+          bundle exec jekyll build -d asf-site/output
+          mv asf-site/output/cwiki_retired/* cwiki-retired
+          rm -rf asf-site/output/cwiki_retired
       - name: 🚀 Add commit to the asf-site branch
         working-directory: asf-site
         run: |
@@ -54,3 +70,16 @@ jobs:
           then
             git push origin asf-site
           fi
+      - name: 🚀 Add commit to the cwiki-retired branch
+        working-directory: cwiki-retired
+        run: |
+          echo "Running git config"
+          git config user.name "GitHub Actions"
+          git config user.email "[email protected]"
+          echo "Running git add -A"
+          git add -A .
+          echo "Running git commit"
+          if git commit -m "Regenerated website based on ${GITHUB_SHA} commit"
+          then
+            git push origin cwiki-retired
+          fi

.gitignore

@@ -1,3 +1,12 @@
-asf-site/
-.svn-legacy/
-*.tmp
+# Ignore the default location of the built site, and caches and metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/
+# Ignore download git-repositories.json
+_data/git-repositories.json
+_data/committee-retired.json

Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
+# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+
+gem "just-the-docs", "0.10.1" # pinned to the current release
+# gem "just-the-docs"        # always download the latest release

Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.5)
+    csv (3.3.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.17.1-arm64-darwin)
+    ffi (1.17.1-x86_64-linux-gnu)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.29.3-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.29.3-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    http_parser.rb (0.8.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.4.1)
+      addressable (~> 2.4)
+      base64 (~> 0.2)
+      colorator (~> 1.0)
+      csv (~> 3.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      json (~> 2.6)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3, >= 0.3.6)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 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)
+    json (2.9.1)
+    just-the-docs (0.10.1)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (6.0.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.4.0)
+    rouge (4.5.1)
+    safe_yaml (1.0.5)
+    sass-embedded (1.83.4-arm64-darwin)
+      google-protobuf (~> 4.29)
+    sass-embedded (1.83.4-x86_64-linux-gnu)
+      google-protobuf (~> 4.29)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.6.0)
+    webrick (1.9.1)
+
+PLATFORMS
+  arm64-darwin
+  x86_64-linux-gnu
+
+DEPENDENCIES
+  jekyll (~> 4.4.1)
+  just-the-docs (= 0.10.1)
+
+BUNDLED WITH
+   2.5.9

README.md

@@ -1,7 +1,135 @@
-This is the source for the Attic website https://attic.apache.org/
+<!--
+#
+# 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.
+#
+-->
 
-Maintained at https://github.com/apache/attic
+# Apache Attic Website
 
-Issue tracking: https://issues.apache.org/jira/projects/ATTIC
+This is the source code for the website at [attic.apache.org](https://attic.apache.org)
+which manages ASF projects which have retired.
 
-Mailing list: [email protected] https://lists.apache.org/[email protected]
+This site uses [Jekyll](https://github.com/jekyll/jekyll), which is a static site generator,
+with the [Just The Docs](https://just-the-docs.github.io/just-the-docs/) Theme. See:
+ - [The Jekyll Docs](https://jekyllrb.com/docs/) on how to install Jekyll and build this
+site locally.
+ - [Just The Docs](https://just-the-docs.github.io/just-the-docs/) on configuring the theme
+
+## Overview
+
+The [Attic Website](https://attic.apache.org) is composed of the following:
+
+  - Simple `markdown` pages such as the _home_ (`index.md`) and _Process_ (`process.md`) pages.
+  - A `yaml` file for each project in the `_data/projects` directory which contains all the
+    details about the project and its retirement
+  - The _Process Tracking_ (`tracking.md`) page which generates a table showing the status of each
+    project generated from the files in `_data/projects' directory.
+  - [Jekyll Plugins](https://jekyllrb.com/docs/plugins/) which generate pages and files for the
+    retired projects from the files in `_data/projects' directory:
+    - `_plugins/projects-plugin.rb` generates the [project pages](https://attic.apache.org/projects/)
+      from the project's `yaml` data file.
+    - `_plugins/attic-banner-plugin.rb` generates a _flag_ file to indicate that the _Attic Banner_
+      should be added to a project's website (based on the project's `yaml` data file).
+    - `_plugins/cwiki-banner-plugin.rb` generates a _flag_ file to indicate that the _Attic Banner_
+      should be added to the project's CWIKI spaces (based on the project's `yaml` data file).
+
+## Project YAML Data File
+
+The project YAML files contain the following information in order to generate the project pages:
+  - **Retirement Date** (usually the date of the board meeting the project was terminated)
+  - **JIRA ID** of the ticket used to track the project's move to the Attic
+  - **Completion Date** of the project's move to the Attic
+  - **Project Description**
+  - **Source Code** repositorie(s)
+  - **Mailing Lists**
+  - **Issue Tracker(s)**
+  - **Wiki** space(s)
+  - **Download Details**
+  - **Related Projects**
+
+Creating/Updating a project's YAML file updates the project page, updates the Tracking page
+and generates any required flags for the project's website and wiki.
+
+The structure of the project YAML file is shown below:
+
+```yaml
+retirement_date: yyyy-mm-dd      ### [REQUIRED] Date the project retired (date of board meeting)
+attic_issue: ATTIC-XXX           ### [OPTIONAL] The JIRA-ID managing the projects retirement
+attic_date: yyyy-mm-dd           ### [OPTIONAL] Date the move to the Attic was completed
+attic_banner: true               ### [OPTIONAL] Valid values: true/false (should banner be generated, normally true)
+revived_date: yyyy-mm-dd         ### [OPTIONAL] Date the project was revived - moved out of the Attic
+project_name: [Another Name]     ### [OPTIONAL] defaults to this file name
+project_longname:                ### [OPTIONAL] defaults to this file name
+project_domain: [alt domain]     ### [OPTIONAL] defaults to this file name + ".apache.org"
+project_description: >-
+    [Project description here]
+additional_text: >-
+    [Put some text here]
+board_resolution: true           ### [REQUIRED] Valid values: true/false (link to board minutes from retirement date?)
+board_reports: true              ### [REQUIRED] Valid values: true/false (include Board Reports section?)
+downloads: true                  ### [REQUIRED] Valid values: true/false (include Downloads section?)
+archive_path:                    ### [OPTIONAL] Defaults to this file name
+source_repositories:
+    - type: Git                  ### [REQUIRED] Valid Values: Subversion, Git (may have both)
+      path: [some/path]          ### [OPTIONAL] Defaults to this file name
+mailing_lists:
+    - dev
+    - commits
+    - user
+mailing_lists_prefix:            ### [OPTIONAL] Defaults to this file name
+issue_tracker:
+    type: JIRA                   ### [REQUIRED] Valid Values: JIRA, Bugzilla
+    keys:
+      - JIRA_KEY_1               ### [OPTIONAL] Defaults to this file name
+wiki:
+    type: CWIKI                  ### [REQUIRED] Valid values: CWIKI
+    keys:
+      - WIKI_KEY_1               ### [OPTIONAL] Defaults to this file name
+related_projects_text: >-
+    [Put some description here]  ### [OPTIONAL]
+related_projects:
+    - name:                      ### [OPTIONAL]
+      url:                       ### [OPTIONAL]
+      description:               ### [REQUIRED]
+
+```
+
+Heres an example of a file for **Any23**:
+
+```yaml
+retirement_date: 2023-06-21
+attic_issue: ATTIC-215
+attic_date: 2023-10-01
+attic_banner: true 
+project_description: >-
+    The mission of Apache Any23 (Anything to Triples) was the creation and
+    maintenance of software related to automatic crawling, parsing, analyzing,
+    producing, validating and converting RDF (Resource Description Framework) data.
+board_resolution: true
+board_reports: true
+downloads: true
+source_repositories:
+    - type: Git
+mailing_lists:
+    - dev
+    - commits
+    - user
+issue_tracker:
+    type: JIRA
+wiki:
+    type: CWIKI
+
+```