Merge branch 'development' into moo/MOO-1393-remove-code-push

Author: ConnorLand

.github/workflows/lint-action.yml

@@ -20,10 +20,10 @@ jobs:
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # Installs NodeJS v20 in runner environment (upgraded from v16 in Feb 2024)
       - name: Install NodeJS
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20'
       # Installs linting tool via npm
@@ -53,6 +53,7 @@ jobs:
           body: |
             ${{ env.VER }}
           branch: lint-docs
+          committer: MarkvanMents <Mark.van.Ments@mendix.com>
           assignees: MarkvanMents
           reviewers: MarkvanMents
           labels: Internal WIP

.github/workflows/remunusedattachments.yml

@@ -17,22 +17,26 @@ jobs:
     runs-on: ubuntu-latest
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+
+      # Checks out your repository under $GITHUB_WORKSPACE, so your job can access it
       - name: Checkout repo
-        uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10' 
       - run: python _scripts/removeUnusedAttachments.py
+
+      # Creates pull request
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
+        uses: peter-evans/create-pull-request@v6
         with:
           commit-message: Run removeUnusedAttachments.py on docs
           title: '[Auto] Remove unused attachments'
           body: |
-            Pull Request to delete attachments shich are no longer used.
+            Pull Request to delete attachments that are no longer used.
             Check the htmltest output from the CI/CD pipeline to ensure that nothing has been removed accidentally.
           branch: rem-unused-attachments
+          committer: MarkvanMents <Mark.van.Ments@mendix.com>
           assignees: MarkvanMents
           reviewers: MarkvanMents
           labels: Internal WIP

.gitignore

@@ -13,6 +13,7 @@ hugo.exe
 # Legacy for users who still have leftovers from previous Docs Stack
 /_site/
 /.vscode/
+/.idea/
 bin
 data/asset*.json
 data/history.yml
@@ -24,4 +25,3 @@ data/history.yml
 mx-1-get-hugo-and-node.ps1
 mx-2-install-dependencies.bat
 mx-3-run-server.bat
-

.travis.yml

@@ -7,14 +7,17 @@ os: linux             # optional, this is default
 dist: jammy          # or bionic | xenial | trusty | precise with xenial as default - Recommended here: https://docs.travis-ci.com/user/reference/overview/#deprecated-virtualization-environments
 
 git:
-  depth: 20000 # We're cloning a max of xxx commits, so the author date is correct
+  depth: 20000 # We're cloning this many commits as it is roughly covering the last 4 years of commits, thus letting us show the last changed date on the documentation pages.
   quiet: true # prevent commit numbers appearing in the log and being flagged as potential security leaks.
   submodules: false # turn off submodules
 
 env:
   global:
 # Global variables can go here, for example HUGO_VERSION if we were using Netlify to publish.
 
+#add group: previous to see if this fixes the stalled npm build - 2025-04-14
+group: previous
+
 branches:
 # build only development and production
   only:
@@ -60,25 +63,34 @@ 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.
   # ------------------------
   -  ./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
+  # Output header in bold white on green
+  - printf '\033[37;42;1m' > $TRAVIS_BUILD_DIR/hugo.log
+  - echo "HUGO was run for environment $TRAVIS_BRANCH" >> $TRAVIS_BUILD_DIR/hugo.log
+  - printf '\033[0;22m' >> $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)
+
   -  ./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.
   - set +o pipefail
+  # Additional info  in bold white on green
+  - printf '\033[37;42;1m' >> $TRAVIS_BUILD_DIR/hugo.log
   - echo "Any errors from HTMLTEST will be treated as warnings - the build will continue." >> $TRAVIS_BUILD_DIR/hugo.log 
+  - printf '\033[0;22m' >> $TRAVIS_BUILD_DIR/hugo.log
   - chmod +x ./htmltest/htmltest
-  - ./htmltest/htmltest 2>&1 | tee -a $TRAVIS_BUILD_DIR/hugo.log
+  # Run htmltest - convert red (91) and green (92) aixterm colors with 8-bit versions (31 and 32).
+
+  - ./htmltest/htmltest 2>&1 | sed "s/\o033\[91/\o033\[31/g; s/\o033\[92/\o033\[32/g" |tee -a $TRAVIS_BUILD_DIR/hugo.log
 
 before_script:
 ##############
   - pyenv versions # list python versions supported by pyenv in case version in next command is removed
-  - pyenv global 3.7.13 # this version needs to be already installed in the travis build
+  - pyenv global 3.8 # this version needs to be already installed in the travis build
   - python -V
 
 script:
@@ -109,7 +121,7 @@ script:
 #  - pwd
 # NB: Have to have something here, otherwise Travis tries to run "npm test"
 # Display the output from hugo and htmltest so it is not folded and hidden, and is at the end of the log.
-  - echo "$(<$TRAVIS_BUILD_DIR/hugo.log)"
+  - printf '\n\n%s\n\n' "$(<$TRAVIS_BUILD_DIR/hugo.log)"
 
 # before_cache
 ############## Skipped
@@ -136,14 +148,14 @@ deploy:
 #
 # Need to decide where to deploy to, so need to do the actual deployment in a script https://docs.travis-ci.com/user/job-lifecycle#complex-build-commands
 #  - aws s3 sync . s3://$TARGETAWSBUCKET --delete --only-show-errors
-  - provider: script
-    script:
-      - $TRAVIS_BUILD_DIR/_scripts/deploy.sh
-    skip_cleanup: true
-    on:
-      branch:
-        - production
-        - development
+  provider: script
+  # ⋮
+  edge: true
+  script: $TRAVIS_BUILD_DIR/_scripts/deploy.sh
+  on:
+    branch:
+      - production
+      - development
 
 after_deploy:
 ############# Skipped

.vscode/spellright.dict

@@ -4,6 +4,6 @@ The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation wh
 
 Under Article 24 (2) of the DSA, online platforms are required to publish "information on the average monthly active recipients of the service" in the EU by February 17, 2023 and at least once every six months thereafter. This is for the purposes of determining whether an online platform is a "very large online platform" (VLOP) as per the DSA, meaning, a platform which reaches an average of at least 45 million users per month in the EU (representing 10% of the EU population). VLOPs are subject to additional requirements due to the role they play in the dissemination of content throughout the EU.
 
-Based on the six-month period from August 2022 to January 2023, the average number of monthly active recipients of our Mendix Community in the EU was well below the threshold of 45 million.
+Based on the six-month period from October 2023 to March 2024, the average number of monthly active recipients of our Mendix Community in the EU was well below the threshold of 45 million.
 
 Since, at the time of publication of this information, the European Commission has not enacted delegated acts (as mentioned under Article 24 (2) of the DSA) on the methodology of the calculation of the number of monthly active recipients, we have performed our calculation to the best of our knowledge based on the current information the DSA provides as well as the European Commission’s guidance on the requirement to publish user numbers of February 1, 2023. We will continue to monitor the number of average monthly active recipients of our Mendix Community in the EU and will publish updated information in accordance with Article 24 (2) of the DSA.

EU-DIGITAL-SERVICES-ACT-FOR-COMMUNITY.md

@@ -4,6 +4,6 @@ The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation wh
 
 Under Article 24 (2) of the DSA, online platforms are required to publish "information on the average monthly active recipients of the service" in the EU by February 17, 2023 and at least once every six months thereafter. This is for the purposes of determining whether an online platform is a "very large online platform" (VLOP) as per the DSA, meaning, a platform which reaches an average of at least 45 million users per month in the EU (representing 10% of the EU population). VLOPs are subject to additional requirements due to the role they play in the dissemination of content throughout the EU.
 
-Based on the six-month period from August 2022 to January 2023, the average number of monthly active recipients of our Mendix Marketplace in the EU was well below the threshold of 45 million.
+Based on the six-month period from October 2023 to March 2024, the average number of monthly active recipients of our Mendix Marketplace in the EU was well below the threshold of 45 million.
 
 Since, at the time of publication of this information, the European Commission has not enacted delegated acts (as mentioned under Article 24 (2) of the DSA) on the methodology of the calculation of the number of monthly active recipients, we have performed our calculation to the best of our knowledge based on the current information the DSA provides as well as the European Commission’s guidance on the requirement to publish user numbers of February 1, 2023. We will continue to monitor the number of average monthly active recipients of our Mendix Marketplace in the EU and will publish updated information in accordance with Article 24 (2) of the DSA.

EU-DIGITAL-SERVICES-ACT-FOR-MARKETPLACE.md

@@ -4,6 +4,6 @@ The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation wh
 
 Under Article 24 (2) of the DSA, online platforms are required to publish "information on the average monthly active recipients of the service" in the EU by February 17, 2023 and at least once every six months thereafter. This is for the purposes of determining whether an online platform is a "very large online platform" (VLOP) as per the DSA, meaning, a platform which reaches an average of at least 45 million users per month in the EU (representing 10% of the EU population). VLOPs are subject to additional requirements due to the role they play in the dissemination of content throughout the EU.
 
-Based on the six-month period from August 2022 to January 2023, the average number of monthly active recipients of our Mendix Documentation in the EU was well below the threshold of 45 million.
+Based on the six-month period from October 2023 to March 2024, the average number of monthly active recipients of our Mendix Documentation in the EU was well below the threshold of 45 million.
 
 Since, at the time of publication of this information, the European Commission has not enacted delegated acts (as mentioned under Article 24 (2) of the DSA) on the methodology of the calculation of the number of monthly active recipients, we have performed our calculation to the best of our knowledge based on the current information the DSA provides as well as the European Commission’s guidance on the requirement to publish user numbers of February 1, 2023. We will continue to monitor the number of average monthly active recipients of our Mendix Documentation in the EU and will publish updated information in accordance with Article 24 (2) of the DSA.

EU-DIGITAL-SERVICES-ACT.md

@@ -1,4 +1,4 @@
-# Mendix Documentation [![hugo_badge](https://img.shields.io/badge/hugo-0.121.2-green.svg)](https://gohugo.io/) [![node_badge](https://img.shields.io/badge/node-20.10.0-green.svg)](https://nodejs.org/en/) [![docsy_badge](https://img.shields.io/badge/docsy-0.9.0-green.svg)](https://www.docsy.dev/)
+# Mendix Documentation [![hugo_badge](https://img.shields.io/badge/hugo-0.126.1-green.svg)](https://gohugo.io/) [![node_badge](https://img.shields.io/badge/node-20.9.0-green.svg)](https://nodejs.org/en/) [![docsy_badge](https://img.shields.io/badge/docsy-0.10.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).
 
@@ -9,24 +9,24 @@ Build status:
 
 ## Contribute
 
-Want to contribute? Take a look at [How to Contribute to Mendix Docs](https://docs.mendix.com/community-tools/contribute-to-mendix-docs/). It will guide you through the process of submitting updates to the docs directly from Github or from a local branch.
+Want to contribute? Take a look at [How to Contribute to Mendix Docs](https://docs.mendix.com/community-tools/contribute-to-mendix-docs/). It will guide you through the process of submitting updates to the docs directly from GitHub or from a local branch.
 
 ## Local Build
 
-You can clone a local copy of the repository and build local previews. The Mendix documentation is built on top of Hugo and Node.JS. The theme of the page is based on Docsy. To develop the documentation locally, follow the steps in the next section.
+You can clone a local copy of the repository and build local previews. The Mendix documentation is built on top of Hugo and Node.js. The theme of the page is based on Docsy. To develop the documentation locally, follow the steps in the next section.
 
 ### Setting Up
 
 #### Cloning the Repo
 
-To clone the repo please keep in mind:
+When you clone the repo, keep the following 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 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.
 
 #### Installing Dependencies
 
-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 and install the LTS version of [Node.js](https://nodejs.org/en/download/prebuilt-installer).
+1. In a terminal at the root of the repository, run `npm install`.
 
 ### Running the Server
 
@@ -37,16 +37,16 @@ To run a local version of the site:
     * `npm run build`
     * `./node_modules/.bin/hugo server --environment development` – in this case, you can use [different parameters](https://gohugo.io/commands/hugo_server/) to build the site in different ways—for example, build a copy of the production site and save it locally. 
 
-        The path syntax prefacing `hugo` may be different based on your operating system and terminal you use.
+        The path syntax prefacing `hugo` may be different based on the 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.
+    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.
 
-2. Go to http://localhost:1313/  and see the site live.
+2. Go to http://localhost:1313/ and see the site live.
 
-See the [Hugo Server](https://gohugo.io/commands/hugo_server/) documentation for more options (for example, if you want to change the port on which the site is published)
+See the [Hugo Server](https://gohugo.io/commands/hugo_server/) documentation for more options (for example, if you want to change the port on which the site is published).
 
 #### Potential Issues
 
 If you are using a Mac, you might get an error `too many open files` or `fatal error: pipe failed`. By default, your Mac is probably set to restrict the number of open files. You will need to override this, see [Docsy known issues](https://www.docsy.dev/docs/getting-started/#known-issues) for more information.
 
-If your system has a low memory limit, add the `--renderToDisk` parameter to the Hugo command, for example `hugo server --environment development --renderToDisk`. With this option, Hugo will only load pages on demand; without the `--renderToDisk` option, Hugo will load all documentation into memory for faster access.
+If your system has a low memory limit, add the `--renderToDisk` parameter to the Hugo command (for example, `hugo server --environment development --renderToDisk`). With this option, Hugo only loads pages on demand; without the `--renderToDisk` option, Hugo loads all documentation into memory for faster access.

README.md

@@ -0,0 +1,42 @@
+// Styling for badges (enabled in the frontmatter)
+// Badge styling mimics the PDS guidelines: https://designsystem.mendix.com/doc/p/Components/Badge/5b0de933-d909-4269-b957-276f16f71341
+// For guidance on how to use these, see https://mendix.atlassian.net/wiki/spaces/RNDHB/pages/2757787839/Front+Matter+Metadata#For-Badges
+
+.badge-pill {
+    border-radius: 4px;
+    padding: 4px 4px 3px 4px;
+    margin-left: 2px;
+}
+
+.badge-draft {
+    background-color: $warning-9;
+  }
+
+.badge-beta {
+    color: $gray-900;
+    background-color: $gray-500;
+}
+
+.badge-lts {
+    background-color: $success-9;
+}
+
+.badge-mts {
+    background-color: $info-8;
+}
+
+.badge-deprecated {
+    background-color: $gray-100;
+    border: solid 1px $gray-500;
+    color: $gray-900;
+}
+
+.badge-recommended {
+    border: solid 1px $success-9;
+    color: $success-9;
+}
+
+.badge-react {
+    background-color: $info-1;
+    color: $info-7;
+}