simplified documentation preprocessing

jflamy · Jan 31, 2025 · 441bd92 · 441bd92
1 parent 3938e79
commit 441bd92
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 172 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -6,7 +6,7 @@ on:
       revision:
         description: 'Revision for the release'
         required: true
-        default: '55.3.0-alpha02'
+        default: '55.3.0-alpha03'
 
 env:
   REPO_OWNER: owlcms
@@ -59,6 +59,9 @@ jobs:
           DOCKER_TAG: ${{ env.DOCKER_TAG }}
 
       - name: Pre-process Documentation and Release Notes
+        env:
+          REPO_OWNER: owlcms
+          O_REPO_NAME: owlcms4${{ env.RELEASE_SUFFIX }}
         run: |
           mvn -B package --non-recursive -Dmaven.test.skip -Drevision=${{ env.REVISION }}
           if [[ "${{ env.REVISION }}" == *"-alpha"* ]]; then
@@ -70,10 +73,7 @@ jobs:
           else
             cat src/main/markdown/release.md ReleaseNotes.md > temp.md && mv temp.md ReleaseNotes.md
           fi
-        env:
-          REPO_OWNER: owlcms
-          O_REPO_NAME: owlcms4${{ env.RELEASE_SUFFIX }}
-
+
       - name: Install GitHub CLI
         run: sudo apt-get install gh -y
 
@@ -98,13 +98,13 @@ jobs:
           cd -
           set +x
 
-      - name: Clean Target Directory
+      - name: Force-copy the new documentation
         run: |
           rm -rf ../new-repo/* # we only want the docs directory
           cp -a docs ../new-repo/docs
           echo ${{ env.REVISION }} > ../new-repo/version.txt
 
-      - name: Push Updated Docs to Target Repository
+      - name: Push Updated Documentation to Target Repository
         env:
           GH_TOKEN: ${{ secrets.OWLCMS_ORG_TOKEN }}
         run: |
@@ -114,7 +114,7 @@ jobs:
           git config user.email "${{ github.actor }}@users.noreply.github.com"
           git config user.name "${{ github.actor }}"
           git add -A
-          git commit -m "Update docs to match dev repo" --allow-empty
+          git commit -m "Update documentation" --allow-empty
           git tag ${{ env.REVISION }}
           git push origin master --force
           git push origin ${{ env.REVISION }}
@@ -139,16 +139,18 @@ jobs:
             publicresults/target/publicresults_${{ env.REVISION }}.zip
           set +x
           
-      - name: Tag Source Repository
+      - name: Update Source Repository
         env:
           GH_TOKEN: ${{ secrets.OWLCMS_ORG_TOKEN }}
         run: |
           set -x
-          git add ReleaseNotes.md
           git config user.email "${{ github.actor }}@users.noreply.github.com"
           git config user.name "${{ github.actor }}"
-          git commit -m "Update Release Notes for ${{ env.REVISION }}" --allow-empty
-          git push origin
+		  # add the release notes
+		  # git add ReleaseNotes.md
+          # git commit -m "Update Release Notes for ${{ env.REVISION }}" --allow-empty
+          # git push origin
+		  # tag
           git tag ${{ env.REVISION }}
           git push origin ${{ env.REVISION }}
           set +x

diff --git a/BUILDING.md b/BUILDING.md
@@ -1,27 +1,24 @@
 ## Building and Packaging
 
-This is a standard Maven project that creates a uberJar with all the dependencies.  If you wish, you can build the binaries from this source.  
-
-This file describes how to build the program without changing it.  If you want to change the code, please see the [Contributing](https://owlcms.github.io/owlcms4/#/Gitpod) documentation.
+This is a standard Maven project.  If you wish, you can build the binaries from this source. 
 
 ### Pre-requisites
 
 - Install git : Installing [GitHub Desktop](https://desktop.github.com/) is the easiest way to install Git on a Windows system. Select the options to add the programs to the execution path.
 - Clone this repository
-- Install Java 17 or newer
+- Install Java 17
 - Install Maven
 
 
 ### Building and testing
 
 - From the owlcms4 directory, running ``mvn -P production -am -pl clean owlcms package `` should give you 
   - `owlcms/target/owlcms.jar` a working  "uberjar" (that is, a .jar file that contains all the dependencies together in a single file).  This file can then be run using `java -jar owlcms.jar app.owlcms.Main` 
-  - `owlcms/target/owlcms.zip` which is used for actual packaging by the owlcms/owlcms-controlpanel project
+  - `owlcms/target/owlcms.zip` contains a copy of the local files required.  This is what the owlcms installers use.
+- The installers are in their own repositories under https://github.com/owlcms and are are built separately.
 
 ### Building a Docker container
 
 There is a Dockerfile in owlcms4top to build owlcms for quick testing to the fly.io cloud (see deploy.sh).  Building publicresults would be similar.
 
-### Release Builds
-
-A full release workflow is in `.github/workflows/release.yaml`
+The current process for actual production builds uses the `owlcms-docker` project to build Docker containers using  `mvn package`, once the production build has been done.
diff --git a/README.md b/README.md
@@ -8,8 +8,7 @@ Yet it is simple enough to setup that you can use it to run a club or regional c
 
 ### Features, Downloads and Installation
 
-- Refer to the  to the [Downloads](https://owlcms.github.io/owlcms4/#/Downloads) page and to the [Installation Overview](https://owlcms.github.io/owlcms4/#/InstallationOverview) for the various setup options.
-  - [Extensive Documentation](https://owlcms.github.io/owlcms4-prerelease/#) is available.
+- Please refer to the [Documentation](https://owlcms.github.io/owlcms4-prerelease/#)
 
 
 ### Help, Issues, Feature Requests
@@ -18,7 +17,7 @@ Yet it is simple enough to setup that you can use it to run a club or regional c
 - [Issues and Feature Requests](https://github.com/jflamy/owlcms4/issues)  Please use the `Issues` button at the top of this page to report issues.
 - [Work in Progress and Priorities](https://github.com/users/jflamy/projects/2/views/7) Shows what we are working on and what is currently planned.
 
-### Release repositories
+### Releases
 
 - Stable releases are kept at https://github.com/owlcms/owlcms4/releases.
 - Preliminary releases for testing and translation are located at https://github.com/owlcms/owlcms4-prerelease/releases.

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
diff --git a/Releases.md b/Releases.md
@@ -2,8 +2,8 @@
 
 There are two release channels: one repository contains stable releases, the second one contains prereleases (for testing and early adopters of new features).
 
-|                                                              | STABLE releases                                              | PRELIMINARY releases                                         |
-| :----------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| **Local Setup**  This installs the `owlcms` program to run a competition locally, on a master laptop.  No internet access is needed. | <ul><li><nobr>[**Windows Installer (owlcms...exe)**](https://github.com/owlcms/owlcms4/releases/latest) and [Instructions](https://owlcms.github.io/owlcms4/#/LocalWindowsSetup)</nobr><li>[**Mac/Linux/Raspberry Kit (owlcms...zip)**](https://github.com/owlcms/owlcms4/releases/latest) and [Instructions](https://owlcms.github.io/owlcms4/#/LocalLinuxMacSetup)<li><nobr>[Release Notes](https://github.com/owlcms/owlcms4/releases)</nobr></ul> | <ul><li><nobr>[Windows Installer (owlcms...exe)](https://github.com/owlcms/owlcms4-prerelease/releases/latest)</nobr><li>[Mac/Linux Kit (owlcms...zip)](https://github.com/owlcms/owlcms4-prerelease/releases/latest)<li><nobr>[Release Notes](https://github.com/owlcms/owlcms4-prerelease/releases)</nobr></ul> |
-| **Cloud-based Setup** This installs the `owlcms` competition management software in the cloud. Good internet access is needed but no local software is needed. The `publicresults` companion program allows individuals to see the scoreboard on their own phone or tablet no matter where they are located. | <ul><li>[Fly.io Cloud Installation Instructions](https://owlcms.github.io/owlcms4/#/Fly)</li></ul> |                                                              |
-| Documentation                                                | [Documentation site](https://owlcms.github.io/owlcms4/#/index) | [Documentation Site](https://owlcms.github.io/owlcms4-prerelease/#/index) |
+|                                                              | Installation Instructions                                    |
+| :----------------------------------------------------------- | ------------------------------------------------------------ |
+| **Local Setup**  This installs the `owlcms` program to run a competition locally, on a master laptop.  No internet access is needed. | <ul><li>[Control Panel Installation Instructions](https://owlcms.github.io/owlcms4/#/LocalDownloads)<li><nobr>[Release Notes](https://github.com/owlcms/owlcms4/releases)</nobr></ul> |
+| **Cloud-based Setup** This installs the `owlcms` competition management software in the cloud. Good internet access is needed but no local software is needed. The `publicresults` companion program allows individuals to see the scoreboard on their own phone or tablet no matter where they are located. | <ul><li>[Fly.io Cloud Installation Instructions](https://owlcms.github.io/owlcms4/#/Fly)</li></ul> |
+| Documentation                                                | [Documentation site](https://owlcms.github.io/owlcms4/#/index) |
diff --git a/src/main/markdown/BUILDING.md b/src/main/markdown/BUILDING.md
diff --git a/src/main/markdown/README.md b/src/main/markdown/README.md
diff --git a/src/main/markdown/Releases.md b/src/main/markdown/Releases.md
diff --git a/src/main/markdown/docs/LocalDownloads.md b/src/main/markdown/docs/LocalDownloads.md