Merge branch 'development' into ufc/state-handling

Author: MarkvanMents

.gitmodules

@@ -9,14 +9,11 @@ dist: jammy          # or bionic | xenial | trusty | precise with xenial as defa
 git:
   depth: 20000 # We're cloning a max of xxx commits, so the author date is correct
   quiet: true # prevent commit numbers appearing in the log and being flagged as potential security leaks.
-  submodules: false # turn off submodules and specifically update them in before_install - preventing the commit numbers appearing in the log
+  submodules: false # turn off submodules
 
 env:
   global:
-# =============================================
-# UPDATE VERSION MANUALLY AND TEST BEFORE MERGE
-# =============================================
-    - HUGO_VERSION=0.91.0 # Choose Hugo version explicitly, in case there is an issue with published version.
+# Global variables can go here, for example HUGO_VERSION if we were using Netlify to publish.
 
 branches:
 # build only development and production
@@ -49,14 +46,9 @@ branches:
 
 before_install:
 ###############
-  # Added the submodule update here so that I can add the --quiet flag
-  - git submodule update --init --recursive --quiet
-  #
+  # Hugo, Docsy and dependencies are installed via npm
   - npm install # use npm rather than yarn - HUGO doesn't have that many dependencies
   #
-  - travis_retry curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_Linux-64bit.tar.gz | tar xz # Install Hugo manually - Snap is too fragile
-  - chmod +x ./hugo # installed into $TRAVIS_BUILD_DIR/hugo
-  #
   # Currently will use custom version of htmltest stored in /htmltest/htmltest
   # This version makes the html.Parse much smaller
   # For htmltest installation instructions, see https://github.com/wjdp/htmltest/blob/master/README.md
@@ -67,14 +59,14 @@ install:
   # ------------------------
   - mkdir public  # This because <Maybe> the process of syncing to public is probably deadlocked behind waiting for the public folder to be made, and is never signalled that the folder is created, which ends up stalling the build on Travis CI.
   # ------------------------
-  - ./hugo config --environment $TRAVIS_BRANCH # report the config we are using
+  -  ./node_modules/.bin/hugo config --environment $TRAVIS_BRANCH # report the config we are using
   - echo "HUGO was run for environment $TRAVIS_BRANCH" > $TRAVIS_BUILD_DIR/hugo.log
   # Set pipefail so that if Hugo fails the whole job fails
   - set -o pipefail
   # put the flags in different config files controlled by environment matching $TRAVIS_BRANCH
   # Append output to hugo.log file to print at the end of the travis job
   # (see https://stackoverflow.com/questions/418896/how-to-redirect-output-to-a-file-and-stdout)
-  - ./hugo --environment $TRAVIS_BRANCH 2>&1 | tee -a $TRAVIS_BUILD_DIR/hugo.log
+  -  ./node_modules/.bin/hugo --environment $TRAVIS_BRANCH 2>&1 | tee -a $TRAVIS_BUILD_DIR/hugo.log
   #
   # normal htmltest takes too much memory - using a modified version which strips <aside> tag content
   # NB - Set pipefail so that Travis CI sees the return code from `tee` and not from `htmltest` so it will always build.

.travis.yml

@@ -1,4 +1,4 @@
-# Mendix Documentation [![badge](https://img.shields.io/badge/hugo-0.91.0-green.svg)](https://gohugo.io/) [![badge](https://img.shields.io/badge/node-16.14.0-green.svg)](https://nodejs.org/en/) [![badge](https://img.shields.io/badge/docsy-0.1.0-green.svg)](https://www.docsy.dev/)
+# Mendix Documentation [![badge](https://img.shields.io/badge/hugo-0.109.0-green.svg)](https://gohugo.io/) [![badge](https://img.shields.io/badge/node-18.14.0-green.svg)](https://nodejs.org/en/) [![badge](https://img.shields.io/badge/docsy-0.6.0-green.svg)](https://www.docsy.dev/)
 
 This repository contains the Mendix documentation, which is served on [https://docs.mendix.com](https://docs.mendix.com).
 
@@ -29,28 +29,22 @@ You can clone a local copy of the repository and build local previews. The Mendi
 
 #### Cloning the Repo
 
-To clone the repo there are a few things to keep in mind:
+To clone the repo please keep in mind:
 
 * If you are running on Windows, the directory path for the local directory should not be too long, otherwise some files will reach the limits of git’s file length. A base path of up to 50 characters works - 64 characters is currently too long.
-* If you are using a Git GUI-based tool (such as Sourcetree), make sure you have **Recurse submodules** checked. Github Desktop does this automatically for you.
-* If you are cloning the repo via Git commands from a terminal, run: `git clone --recurse-submodules https://github.com/mendix/docs`
-
-Clone the repo through one of the above mentioned methods. Check that you have content within the directory `/themes/docsy/`.
 
 #### Installing Dependencies
 
-1. Download and install [NodeJS](https://nodejs.org/en/download/). Use the version indicated at the top of this readme.
+1. Download and install the LTS version of [NodeJS](https://nodejs.org/en/download/).
 1. In a terminal at the root of the repository run: `npm install`.
-1. Download the [0.91 Hugo](https://github.com/gohugoio/hugo/releases/tag/v0.91.0) *extended* version.
-1. Extract hugo.exe from the archive and place it in the root of the repo directory. None of the other files are needed.
-
-Changes made to your local repository, such as adding the Hugo executable, should be excluded from git control. If any new/changed files are added to your uncommitted files, please do not commit the changes.
 
 ### Running the Server
 
 To run a local version of the site: 
 
-1. Run cmd: `hugo server --environment development`
+1. Run cmd: `./node_modules/.bin/hugo server --environment development`
+
+    The path syntax prefacing `hugo` may be different based on your operating system and terminal you use. 
 
     Once the site is built you will see a table indicating how many pages have been created. You will need to wait until the server is set up before you can see the site.