Merge branch 'master' into patch-1

Author: poespas

.devcontainer/devcontainer.json

@@ -12,7 +12,6 @@
     },
     "vscode": {
       "extensions": [
-        "bierner.markdown-mermaid",
         "davidanson.vscode-markdownlint",
         "ms-python.python"
       ]

.github/workflows/cleanup_acceptance.yaml

@@ -7,7 +7,7 @@ on:
 jobs:
   cleanup:
     runs-on: ubuntu-latest
-    container: quay.io/hypernode/deploy:3-php8.1-node18
+    container: quay.io/hypernode/deploy:latest-php8.4-node22
     environment: acceptance
     steps:
       - uses: actions/checkout@v2

.github/workflows/deploy.yaml

@@ -12,7 +12,7 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-    container: quay.io/hypernode/deploy:3-php8.1-node18
+    container: quay.io/hypernode/deploy:latest-php8.4-node22
     steps:
       - uses: actions/checkout@v3
         with:
@@ -34,7 +34,7 @@ jobs:
           echo "DOCS_INDEX_FOLLOW=1" >> $GITHUB_ENV
       - run: hypernode-deploy build -vvv
       - name: archive production artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: deployment-build
           path: build/build.tgz
@@ -47,13 +47,13 @@ jobs:
       name: acceptance
       url: ${{ steps.get_brancher_hostname.outputs.BRANCHER_URL }}
     if: github.ref != 'refs/heads/master'
-    container: quay.io/hypernode/deploy:3-php8.1-node18
+    container: quay.io/hypernode/deploy:latest-php8.4-node22
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: download build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: deployment-build
           path: build/
@@ -102,11 +102,11 @@ jobs:
       name: production
       url: https://docs.hypernode.io
     if: github.ref == 'refs/heads/master'
-    container: quay.io/hypernode/deploy:3-php8.1-node18
+    container: quay.io/hypernode/deploy:latest-php8.4-node22
     steps:
       - uses: actions/checkout@v3
       - name: download build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: deployment-build
           path: build/

.github/workflows/detect_renamed_docs.yaml

@@ -20,7 +20,7 @@ jobs:
           echo "$result" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
         shell: bash
-      - name: Comment hostname on PR
+      - name: Comment changed files on PR
         if: ${{ steps.changed_files.outputs.CHANGED_FILES }}
         uses: thollander/actions-comment-pull-request@v1
         with:

.github/workflows/lint.yaml

@@ -0,0 +1,29 @@
+name: Run linting and suggest changes
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -r requirements/base.txt
+      - name: Check markdown format
+        run: mdformat docs/
+      - uses: parkerbxyz/suggest-changes@v2
+        with:
+          event: 'REQUEST_CHANGES'

.github/workflows/test.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.11', '3.12']
 
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -7,5 +7,6 @@ pub
 .ssh
 .vscode
 *.css.map
+*.br
 deployment-report.json
 build/

README.md

@@ -2,14 +2,14 @@
 
 ## Generating new docs
 
-``` bash
-DOC_URL=https://support.hypernode.com/en/ecommerce/magento-1/how-to-enable-mysql-query-logging-for-magento-1-x
+```bash
+DOC_URL=https://docs.hypernode.com/en/ecommerce/magento-1/how-to-enable-mysql-query-logging-for-magento-1-x
 bin/download_doc --output-dir=docs/ecommerce-applications $DOC_URL
 ```
 
 ## Setting up the project
 
-``` bash
+```bash
 mkvirtualenv hypernode-docs-next
 echo "export PYTHONPATH=$(pwd)" >> $VIRTUAL_ENV/bin/postactivate
 workon hypernode-docs-next
@@ -19,35 +19,40 @@ pre-commit install
 
 ## Building the docs
 
-``` bash
+```bash
 bin/build_docs
 ```
 
 ## Serving the docs
 
-``` bash
+```bash
 bin/serve_docs
 ```
+
 ## Setup Frontend step by step
+
 ```
 clone the repository
 pip install -r requirements/development.txt
 bin/build_docs
 bin/serve_docs
 ```
+
 in another terminal run
-``` bin/watch ```
+`bin/watch`
 
 open localhost and now you can make changes in style and refresh the page without rebuilding
 
 when you're working on scss to compile it automatically run
+
 ```
-sass --watch docs/_static/scss:docs/_static/css
+npx sass --watch docs/_static/scss:docs/_static/css
 ```
 
-or after changes compile scss once:
+or as a production build:
+
 ```
-sass docs/_static/scss:docs/_static/css
+npx sass --style compressed --no-source-map docs/_static/scss:docs/_static/css
 ```
 
 ## Deployment
@@ -57,6 +62,7 @@ Deploys automatically after merging branchers to master.
 ### Deploy with Hypernode Deploy
 
 To deploy to a local Hypernode Docker environment:
+
 ```
 $ docker pull docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
 $ docker run docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
@@ -66,6 +72,7 @@ $ # Note the IP address, it should be 172.17.0.2 (otherwise refer to deploy.php)
 Next make sure your `~/.ssh/yourdeploykey` equivalent can log in to the Docker host (172.17.0.2) as the app user. You can add it to the `/data/web/.ssh/authorized_keys` file on in the instance manually.
 
 Then deploy to your local Hypernode Docker:
+
 ```
 docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy build -vvv  # First build the artifact
 docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy deploy docker -vvv  # Then perform the deploy
@@ -74,6 +81,7 @@ docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)"
 ## Building the manpage deb
 
 The docs are also packaged as a debian package named `hndocsnext` so that on a Hypernode you can run `man hypernode` (or `hypernode-manual`) and page through a `manpage` version of the Hypernode docs. To build that debian package on a Debian machine you can run these commands:
+
 ```
 # First create the cow environment
 export ARCH=amd64
@@ -91,16 +99,19 @@ gbp buildpackage --git-pbuilder --git-dist=$DIST --git-arch=$ARCH --git-ignore-b
 ```
 
 Then after building the Deb you could install it with dpkg. For example:
+
 ```
 dpkg -i ../hndocsnext_20230121.173551_all.deb
 ```
 
 And test it out with:
+
 ```
 man hypernode
 ```
 
 To inspect the contents of the deb archive you can run:
+
 ```
 # dpkg -L hndocsnext
 /.

bin/build_manpage

@@ -4,5 +4,5 @@ set -e
 
 pushd docs
 make man
-echo "manpage located at $(realpath _build/man/docs.1)"
+echo "manpage located at $(realpath _build/man/documentation.1)"
 popd

bin/watch

@@ -1,12 +1,13 @@
 #!/usr/bin/env python3
-import datetime
+import os
 import subprocess
-
-from inotify.adapters import InotifyTree
+import time
+from pathlib import Path
+from time import sleep
 
 
 def build_docs():
-    subprocess.check_call("bin/build_docs")
+    subprocess.run("bin/build_docs")
 
 
 def refresh_assets():
@@ -15,54 +16,57 @@ def refresh_assets():
     )
 
 
-def watch_for_changes(debug=False):
-    i = InotifyTree("docs")
+def watch_for_changes():
+    """Watch for changes using watchdog."""
+    from watchdog.events import FileSystemEvent, FileSystemEventHandler
+    from watchdog.observers import Observer
+
+    class MyHandler(FileSystemEventHandler):
+        def __init__(self):
+            super().__init__()
+            self.last_build = time.time()
 
-    IGNORED_EVENTS = ["IN_CLOSE_WRITE", "IN_CLOSE_NOWRITE", "IN_ACCESS", "IN_OPEN"]
-    IGNORED_PATHS = ["docs/_build"]
+        def on_modified(self, event: FileSystemEvent):
+            cwd = os.getcwd()
+            file_path = Path(event.src_path)
 
-    last_build = None
+            IGNORED_PATHS = ["docs/_build"]
 
-    for event in i.event_gen(yield_nones=False):
-        (_, type_names, path, filename) = event
+            if event.is_directory:
+                return
 
-        ignore = False
-        for ignored_event_type in IGNORED_EVENTS:
-            if ignored_event_type in type_names:
-                ignore = True
-                break
+            if file_path.name.isdigit():
+                return
 
-        for ignored_path in IGNORED_PATHS:
-            if path.startswith(ignored_path):
-                ignore = True
-                break
+            if (
+                file_path.name.endswith(".swx")
+                or file_path.name.endswith(".swp")
+                or file_path.name.endswith("~")
+            ):
+                return
 
-        if (
-            filename.endswith(".swx")
-            or filename.endswith(".swp")
-            or filename.endswith("~")
-        ):
-            ignore = True
+            for ignored_path in IGNORED_PATHS:
+                ignored_path = os.path.join(cwd, ignored_path)
+                if str(file_path).startswith(ignored_path):
+                    return
 
-        if ignore:
-            continue
+            if self.last_build and time.time() - self.last_build < 0.5:
+                return
 
-        if last_build:
-            # If build has been triggered in the last 50 ms, skip
-            delta = (datetime.datetime.now() - last_build).microseconds / 1000
-            if delta < 50:
-                continue
+            build_docs()
+            refresh_assets()
+            self.last_build = time.time()
 
-        build_docs()
-        refresh_assets()
-        last_build = datetime.datetime.now()
+    event_handler = MyHandler()
+    observer = Observer()
+    observer.schedule(event_handler, path="docs", recursive=True)
+    observer.start()
 
-        if debug:
-            print(
-                "PATH=[{}] FILENAME=[{}] EVENT_TYPES={}".format(
-                    path, filename, type_names
-                )
-            )
+    try:
+        while True:
+            sleep(1)
+    except KeyboardInterrupt:
+        observer.stop()
 
 
 if __name__ == "__main__":