Merge branch 'development' into MvM-OIDCProvider

Author: MarkvanMents

.github/workflows/lint-action.yml

@@ -52,8 +52,8 @@ jobs:
           body: |
             ${{ env.VER }}
           branch: lint-docs
-          assignees: NatasaKralj
-          reviewers: NatasaKralj
+          assignees: MarkvanMents
+          reviewers: MarkvanMents
           labels: Internal WIP
           add-paths: |
             content/en/docs/**/*.md

.github/workflows/remunusedattachments.yml

@@ -0,0 +1,37 @@
+# This is a basic workflow to help you get started with Actions
+name: Remove unused attachments
+
+# Controls when the workflow will run
+on:
+  #schedule:
+    #- cron: '00 08 22 * *'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "rem-unused-attachments"
+  rem-unused-attachments:
+    # The type of runner that the job will run on
+    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
+      - name: Checkout repo
+        uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10' 
+      - run: python _scripts/removeUnusedAttachments.py
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: Run removeUnusedAttachments.py on docs
+          title: '[Auto] Remove unused attachments'
+          body: |
+            "We're trying to delete some unnecessary attachments."
+          branch: rem-unused-attachments
+          assignees: JohannaHemminger
+          reviewers: JohannaHemminger
+          labels: Internal WIP
+          add-paths: |
+            static/attachments/**

.travis.yml

@@ -1,10 +1,10 @@
 language: node_js
 node_js:
-  - 16                # latest LTS version ('node' will give latest version)
+  - 18             # latest LTS version ('node' will give latest version, 'lts/*' will give LTS version )
 arch: amd64           # optional, this is default, routes to a full VM
 # arch: arm64         # this is the recommended LXD container - faster spin up but some limitations Not used as it seems very unstable.
 os: linux             # optional, this is default
-dist: xenial          # or bionic | xenial | trusty | precise with xenial as default - Recommended here: https://docs.travis-ci.com/user/reference/overview/#deprecated-virtualization-environments
+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
@@ -86,7 +86,7 @@ install:
 before_script:
 ##############
   - pyenv versions # list python versions supported by pyenv in case version in next command is removed
-  - pyenv global 3.6.7 # this version needs to be already installed in the travis build
+  - pyenv global 3.7.13 # this version needs to be already installed in the travis build
   - python -V
 
 script:

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

@@ -0,0 +1,10 @@
+# EU Digital Services Act
+
+The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation which entered into force on November 16, 2022.  It aims to set out harmonized rules for a safe, predictable and trusted online environment applicable to intermediary services that, among others, connect users with goods, services, and content from others and includes online platforms such as the Mendix Community: https://forum.mendix.com/.
+
+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.
+
+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-MARKETPLACE.md

@@ -0,0 +1,9 @@
+# EU Digital Services Act
+
+The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation which entered into force on November 16, 2022.  It aims to set out harmonized rules for a safe, predictable and trusted online environment applicable to intermediary services that, among others, connect users with goods, services, and content from others and includes online platforms such as the Mendix Marketplace: https://marketplace.mendix.com/.
+
+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.
+
+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.md

@@ -0,0 +1,9 @@
+# EU Digital Services Act
+
+The Digital Services Act (DSA, Regulation (EU) 2022/2065) is an EU Regulation which entered into force on November 16, 2022.  It aims to set out harmonized rules for a safe, predictable, and trusted online environment applicable to intermediary services that, among others, connect users with goods, services, and content from others and includes online platforms such as the Mendix Documentation: https://docs.mendix.com/.
+
+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.
+
+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.

README.md

@@ -7,6 +7,16 @@ Build status:
 * production [![Build Status](https://secure.travis-ci.org/mendix/docs.png?branch=production)](https://app.travis-ci.com/github/mendix/docs)
 * development [![Build Status](https://secure.travis-ci.org/mendix/docs.png?branch=development)](https://app.travis-ci.com/github/mendix/docs)
 
+## Working in the Mx10 Private Repo
+
+To make Mx10 Beta 1 updates here, please do the following:
+
+1. Create a separate branch off of the `mx-10-branch`.
+    1. Do not commit directly to `development` or `production`!
+2. Make your documentation changes.
+3. Create a pull request with those changes. Make sure you chose the `mx-10-branch` as the base branch.
+4. Your component’s dedicated technical writer will be assigned to review your work.
+
 ## Contribute
 
 Want to contribute? Take a look at [How to Contribute to the Mendix Documentation](https://docs.mendix.com/developerportal/community-tools/contribute-to-the-mendix-documentation). It will guide you through the process of submitting updates to the docs directly from Github or from a local branch.
@@ -51,3 +61,5 @@ See the [Hugo Server](https://gohugo.io/commands/hugo_server/) documentation for
 #### 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.

_scripts/removeUnusedAttachments.py

@@ -0,0 +1,66 @@
+"""
+removeUnusedAttachments.py goes through all .md files to make a list of attachment links.
+"""
+
+import re
+import logging
+import pathlib
+
+# Generic walk function for crawling through a directory
+def dirWalk(start, globPattern="**/*"):
+    dirList = list(start.glob(globPattern))
+    return dirList
+
+# Create log file so we can check out the list of attachments later
+logging.basicConfig(filename='attachmentlistlog.log', filemode='w', format='%(message)s')
+
+# Grab content directory
+startDir = "content/en/docs/"
+# Define the start directory object
+start = pathlib.Path(startDir)
+
+# Create an empty list to help with parsing data
+attachmentList = [] 
+
+# Walk through all directories and files to find .md files and create a list of them
+dirList_1 = dirWalk(start, "**/*.md")
+# Walk through all files in directory
+for dirListItem in dirList_1:
+    # Relative file path that includes name of file
+    relFilePath = dirListItem.relative_to(start) #os.path.relpath(filePath, startDir) was what we had before
+    # Pattern to find any /attachments/ followed by either ) or "
+    fullAttachmentRefSearch = '/attachments/([-./\+\w= ]*)?(?:\)|")'
+    # Opens Markdown file and goes through every line
+    with open(dirListItem, mode='r', encoding="utf-8") as mdFile:
+        for line in mdFile:
+            fullSearch = re.findall(fullAttachmentRefSearch,line)
+            if fullSearch != []:
+                for searchitem in fullSearch:
+                    # Creates a dictionary for file with attachments
+                    itemDict = {"File path": relFilePath, "File name": dirListItem.name, "Attachment Link": searchitem}
+                    # Appends each dictionary to attachmentList
+                    attachmentList.append(itemDict)                    
+logging.warning(attachmentList)
+
+# Grab attachment directory
+attachmentDir = "static/attachments/"
+# Define the attachment directory object
+attachment_start = pathlib.Path(attachmentDir)
+
+# Walk through all directories and files and create a list, then check that they're in the attachmentList
+dirList_2 = dirWalk(attachment_start, "**/*.*")
+# For a file in dirList_2, mark that it should be deleted by default
+for file in dirList_2:
+    deleteFlag = True
+    # fullSearch returns a list, so we need to pull things (items) out of it
+    for item in attachmentList:
+        inList = item["Attachment Link"]
+        # If there's something in the attachment list that's also in dirList2, then we want to keep it
+        if file.name in inList:
+            deleteFlag = False
+            break
+    # Delete files that are in dirList2 and not in the attachment list
+    if deleteFlag is True:
+        # Make sure that it is not a directory
+        if pathlib.Path.is_file(file):
+            pathlib.Path.unlink(file)

assets/js/progress-tracking.js

@@ -46,27 +46,25 @@
       return {navElement: element, targetElement};
     });
 
-// We have removed this, so it isn't found. Remove altogether - see commented lines below
+// NK - navbarHeight is changed so highlighting in ToC while scrolling isn't impacted by MxDock height - see commented line below
 // const navbarHeight = window.document.querySelector("header > nav").offsetHeight;
-  
+    const navbarHeight = 49; // 1+MxDock offset height (in px) as set in scroll-padding-top in assets/scss/_main-container.scss
+
     const handleActiveSection = () => {
       // The array should be sorted according to the position of the elements on the page
       navItems.sort((a, b) => a.targetElement.offsetTop - b.targetElement.offsetTop);
 
       let currentActiveIndex;
 
       // If the top of the window is above the first element, select the first element
-      //if (navItems[0].targetElement.offsetTop + navbarHeight > window.scrollY) {
-      if (navItems[0].targetElement.offsetTop > window.scrollY) {
+      if (navItems[0].targetElement.offsetTop - navbarHeight > window.scrollY) {
             currentActiveIndex = 0;
       // If the top of the window is under the last element, select the last element
-//      } else if (navItems[navItems.length - 1].targetElement.offsetTop + navbarHeight < window.scrollY) {
-      } else if (navItems[navItems.length - 1].targetElement.offsetTop < window.scrollY) {
+      } else if (navItems[navItems.length - 1].targetElement.offsetTop - navbarHeight < window.scrollY) {
                 currentActiveIndex = navItems.length - 1;
       } else {
         // Try to determine the best element
-//        currentActiveIndex = navItems.findIndex((item) => item.targetElement.offsetTop + navbarHeight > window.scrollY) - 1;
-        currentActiveIndex = navItems.findIndex((item) => item.targetElement.offsetTop > window.scrollY) - 1;
+        currentActiveIndex = navItems.findIndex((item) => item.targetElement.offsetTop - navbarHeight > window.scrollY) - 1;
       }
 // MvM: Change classlist to use our activeToc rather than 'current' specified in Docsy PR
       navItems.forEach((item) => item.navElement.classList.remove('activeToc'));

assets/scss/_main-container.scss

@@ -1,3 +1,8 @@
+// NK - Sets default offset for any inline anchor from height of dock
+html {
+    scroll-padding-top: 48px; /* height of sticky header */
+}
+
 // The outer page container i.e. common styles for any page.
 .td-outer {
     display: flex;