Merge pull request #37 from ByteInternet/markdown_format

Author: tdgroot

.github/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: Run tests
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+
+    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
+          pip install tox tox-gh-actions
+      - name: Check markdown format
+        run: mdformat --check docs/
+      - name: Test with tox
+        run: tox

README.md

@@ -29,7 +29,7 @@ bin/build_docs
 bin/serve_docs
 ```
 ## Setup Frontend step by step
-``` 
+```
 clone the repository
 pip install -r requirements/development.txt
 bin/build_docs

bin/watch

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 import datetime
-import os
 import subprocess
 
 from inotify.adapters import InotifyTree
@@ -38,7 +37,11 @@ def watch_for_changes(debug=False):
                 ignore = True
                 break
 
-        if filename.endswith(".swx") or filename.endswith(".swp") or filename.endswith("~"):
+        if (
+            filename.endswith(".swx")
+            or filename.endswith(".swp")
+            or filename.endswith("~")
+        ):
             ignore = True
 
         if ignore:

docs/about-hypernode/about-hypernode.md

@@ -1,9 +1,10 @@
 # About Hypernode
 
 ```{toctree}
-:caption: 'Table of Contents'
-:maxdepth: 1
-:glob:
-
+---
+caption: Table of Contents
+maxdepth: 1
+glob:
+---
 about-hypernode/*
 ```

docs/about-hypernode/about-hypernode/hypernode-and-team-blue.md

@@ -1,4 +1,5 @@
 <!-- source: https://support.hypernode.com/en/about/about-us/hypernode-and-team-blue/ -->
+
 # Hypernode and team.blue
 
 From 2019 Hypernode is part of team.blue, a leading digital enabler for companies and entrepreneurs.
@@ -9,10 +10,10 @@ The vision of the group has always been to grow the business by acquiring and in
 
 Thanks to a continuous strong organic growth and additional acquisitions, Combell Group has become a market leader in hosting services in the Benelux and The Nordics. We're now the 3rd biggest cloud hosting company in Europe, and a leading mass webhoster in Northwest Europe.
 
-In 2019 Combell Group (“Combell”) and TransIP Group (“TransIP”) merged into team.blue, one of the latest European tech companies to exceed a $1 billion valuation. Team.blue offers digital tools such as hosting, email and applications to over 1.2 million customers across Europe, with a base of over 600 employees working in expert teams.
+In 2019 Combell Group (“Combell”) and TransIP Group (“TransIP”) merged into team.blue, one of the latest European tech companies to exceed a \$1 billion valuation. Team.blue offers digital tools such as hosting, email and applications to over 1.2 million customers across Europe, with a base of over 600 employees working in expert teams.
 
 In this team.blue group Hypernode is part of team.blue NL. A few of the other companies in this vertical are TransIP, CloudVPS, Signet, Proserve, Vimexx and Breedband.
 
 Given that Hypernode is part of team.blue, we will collaborate with other team.blue companies on different projects.
 
-You can find more information about team.blue on [this website](https://team.blue/). 
+You can find more information about team.blue on [this website](https://team.blue/).

docs/about-hypernode/about-hypernode/hypernode-certification-for-agencies.md

@@ -1,13 +1,12 @@
 <!-- source: https://support.hypernode.com/en/about/about-us/hypernode-certification-for-agencies/ -->
+
 # Hypernode Certification for Agencies
 
 Hypernode Certified developers have shown that they are among the top Magento development agencies in the Benelux. They are periodically assessed by our Magento experts on output (fast and safe Magento webshops) and development processes.
 
 This article explains the importance of a Hypernode certification for Magento developers and online retailers and how, as a Magento development agency, you can become a Hypernode Certified Agency.
 
-
-Our Mission
------------
+## Our Mission
 
 Over 65% of the Dutch Magento agencies are currently working with Hypernode. Our custom-made platform helps Magento agencies to develop, manage and maintain high quality standards for Magento shops.
 
@@ -19,37 +18,34 @@ We want to use these learnings by contributing to the quality of the whole Magen
 
 Our goal: happy and satisfied Magento users. How?
 
-* By challenging Magento agencies to improve their quality even more than they already do.
-* By providing Magento merchants a list of the best Magento development agencies worldwide.
-* By sharing best practices concerning Magento development.
-* By auditing certified agencies on their output and processes, not at a specific moment in time, but periodically. This certification program is not a one-time check, but a continuous guarantee of quality.
+- By challenging Magento agencies to improve their quality even more than they already do.
+- By providing Magento merchants a list of the best Magento development agencies worldwide.
+- By sharing best practices concerning Magento development.
+- By auditing certified agencies on their output and processes, not at a specific moment in time, but periodically. This certification program is not a one-time check, but a continuous guarantee of quality.
 
-Criteria and Guidelines
------------------------
+## Criteria and Guidelines
 
 A Hypernode Certified Agency delivers excellent quality when it comes to development and management of Magento webshops which will lead to happy customers.
 
 **The criteria for receiving the certificate are as follows:**
 
-* A Hypernode Certified Agency develops and manages Magento shops with outstanding performance.
-* A Hypernode Certified Agency develops and manages Magento shops with the highest level of security.
-* A Hypernode Certified Agency works with professional processes concerning development, deployment and management.
-* A Hypernode Certified Agency has thorough knowledge of Magento.
-* A Hypernode Certified Agency manages at least 5 Magento 2 stores in production on a Hypernode.
+- A Hypernode Certified Agency develops and manages Magento shops with outstanding performance.
+- A Hypernode Certified Agency develops and manages Magento shops with the highest level of security.
+- A Hypernode Certified Agency works with professional processes concerning development, deployment and management.
+- A Hypernode Certified Agency has thorough knowledge of Magento.
+- A Hypernode Certified Agency manages at least 5 Magento 2 stores in production on a Hypernode.
 
 To check if an agency meets the criteria mentioned above, we maintain standards. Two weeks before the deadline to participate in an audit we will send out these standards to interested agencies with the request to prove to us how they meet these standards.
 
 After receiving the Hypernode certificate, we continuously evaluate if agencies still meet the high-quality standards. This way the certification is not a one-time check, but a continuous evaluation over time.
 
-Registration Procedure
-----------------------
+## Registration Procedure
 
 Throughout the year, Magento development agencies using the Hypernode platform can apply for Hypernode certification. If you want to qualify for this, send an email to: certification@hypernode.com. In this you indicate that you would like to participate in the next audit round and you specify a contact person in advance.
 
 There is an audit moment every six months. We send all interested Magento development agencies the guidelines that a Hypernode Certified development agency must meet. It is then up to the agencies to demonstrate that they comply with these guidelines. The audit is based on the input submitted and a telephone conversation for a personal explanation.
 
-FAQ
----
+## FAQ
 
 ### What Is the Difference Between Hypernode Certification and Magento Certification?
 

docs/about-hypernode/about-hypernode/upgrade-to-debian-buster-technical-implications.md

@@ -1,11 +1,10 @@
 <!-- source: https://support.hypernode.com/en/about/about-us/upgrade-to-debian-buster-technical-implications/ -->
+
 # Upgrade to Debian Buster: Technical Implications
 
 Because it is important to keep your hosting environment up to date we’re upgrading all Hypernodes from the Ubuntu Xenial operating system to the new Debian Buster OS. While we have worked hard to keep this upgrade as non-intrusive for the user as possible, this article lists some of the changes you might experience after having been upgraded to the new operating system. If you’re interested in the motivations for this upgrade check out [this previous changelog.](https://changelog.hypernode.com/changelog/release-7279-beta-debian-buster-hypernode-docker-and-configuration-specific-images/)
 
-
-Software Version Changes
-------------------------
+## Software Version Changes
 
 These are some of the versions of software available on the system that have changed in this OS upgrade. Note that this list is not exhaustive and only a snapshot of the situation of the platform during the moment of the initial transition between OS versions. Over time as the platform develops these versions might be mutated further. See the [Hypernode changelog](https://support.hypernode.com/changelog/) for the most up to date reports on changes to the platform.
 
@@ -31,18 +30,21 @@ php-imagick -> Xenial: 3.4.4-1-byte1 -> Buster: 3.4.4-4
 redis-server -> Xenial: 2:3.0.6-1ubuntu0.4 (v=3.0.6) -> Buster: 5:5.0.3-4+deb10u1 (v=5.0.3)
 nginx -> Xenial: 1.13.9-1 -> Buster: 1.16.1-3
 ```
+
 ### Python
 
 While most users on Hypernode do not actively use the Python interpreter there are some users who run Python scripts or use tooling that uses the Python interpreter (like using [Ansible](https://github.com/ansible/ansible) to deploy to Hypernode). In Debian Buster the system Python will remain Python 2. This minor upgrade should not cause any incompatibilities.
 
 ```bash
 python -> Xenial: 2.7.12-1ubuntu0~16.04.11 -> Buster: 2.7.16-1
 ```
+
 Python 3 will be significantly updated though. If you run Python scripts and run into problems make sure to check those don’t use any features that have since been deprecated. For more information see the [Python changelog](https://docs.python.org/3/whatsnew/3.7.html).
 
 ```bash
 python3 -> Xenial: 3.5.1-3 -> Buster: 3.7.3-1
 ```
+
 ### Other Interpreters
 
 Here are some of the version changes of other interpreters. Even if you don’t actively program in these languages you might be using a tool that is using one of these interpreters (for example, if you instead of Ansible use [Capistrano](https://capistranorb.com/) to deploy that tool would be running on the Ruby programming language).
@@ -52,6 +54,7 @@ ruby -> Xenial: 1:2.3.0+1 -> Buster: 1:2.5.1
 ruby2 -> Xenial: 2.3.1-2~ubuntu16.04.14 -> Buster: 2.5.5-3+deb10u1
 perl -> Xenial: 5.22.1-9ubuntu0.6 -> Buster: 5.28.1-6
 ```
+
 ### Shells
 
 In case you use some esoteric shell features and are interested in these version changes:
@@ -61,6 +64,7 @@ bash -> Xenial: 4.3-14ubuntu1.4 -> Buster: 5.0-4
 dash -> Xenial: 0.5.8-2.1ubuntu2 -> Buster: 0.5.10.2-5
 zsh -> Xenial: 5.1.1-1ubuntu2.3 -> Buster: 5.7.1-1
 ```
+
 ### Various system utilities and more
 
 These are the version changes between various system utilities
@@ -75,25 +79,29 @@ tmux -> Xenial: 2.1-3build1 -> Buster: 2.8-3
 screen -> Xenial: 4.3.1-2build1 -> Buster: 4.6.2-3
 rsync -> Xenial: 3.1.1-3ubuntu1.3 -> Buster: 3.1.3-6
 ```
-Other changes
--------------
-
-* **ElasticSearch 5.2 will no longer be available**. You can use `hypernode-systemctl settings elasticsearch_version --value 6.x` to upgrade to `6.6.1`
-* Newer kernel, systemd, libc, openssl, gcc, [cgroup v2 hierarchy](https://www.kernel.org/doc/Documentation/cgroup-v2.txt) and those type of fun things. Not so much relevant for end users, but it is for the development of the platform from our side in regards to dealing with [backwards incompatible changes in the software stack](https://github.com/elastic/elasticsearch/issues/23486) and being able to use new features for managing the fleet.
-* The root disk size will now be `20 GB` on all nodes. Previously this was the case for OpenStack and DigitalOcean nodes, but for AWS the root disk size was the EC2 default of `8 GB`. For some Hypernodes this caused issues at peak moments when the access logs would be written to so fast that the log rotation couldn’t keep up. In the future this should be less of an issue because now there will be more space available. If you encounter such issues still with this increased capacity you can consider things like putting your [MySQL temporary directory on the /data disk](https://changelog.hypernode.com/changelog/release-5133-configurable-mysql-temporary-directory-extra-space/) in order to free up some more space.
-* TLS 1.3 has been added. Note that TLS 1.1 and TLS 1.0 are deprecated and will be disabled at a later point in time. You can already enable a stricter cipher suite [using the hypernode-api](https://community.hypernode.io/#/Documentation/hypernode-api/settings/README).
-* Curl has been updated to support and prefer HTTP/2. This may cause a problem if you use outdated Magento/Zend core libraries that can't interpret HTTP/2. If this is the case, you should modify your code to explicitly ask for a supported version. If you're using curl, you can do so by using something akin to:
-	+ ```
-	curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
-	```
-* The OpenSSL seclevel has been updated to from '1' to '2'. This may reduce interoperability with older systems that are using pre-2013 industry standards. If this is the case you can downgrade your TLS settings using the command
-	+ ```
-	hypernode-systemctl settings support_insecure_legacy_tls_enabled True
-	```
-
-Checking if a Hypernode Has Been Upgraded Yet
----------------------------------------------
-
-You can check the [message of the day](https://en.wikipedia.org/wiki/Motd_(Unix)) when you log in with ssh as it displays the `OS`, or run `lsb_release -a` or `cat /etc/os-release`. Alternatively you can check using [screenfetch](https://github.com/ByteInternet/screenfetch). On Buster you’ll see the Hypernode bot, on Xenial the package is not installed and the command is not available.
+
+## Other changes
+
+- **ElasticSearch 5.2 will no longer be available**. You can use `hypernode-systemctl settings elasticsearch_version --value 6.x` to upgrade to `6.6.1`
+- Newer kernel, systemd, libc, openssl, gcc, [cgroup v2 hierarchy](https://www.kernel.org/doc/Documentation/cgroup-v2.txt) and those type of fun things. Not so much relevant for end users, but it is for the development of the platform from our side in regards to dealing with [backwards incompatible changes in the software stack](https://github.com/elastic/elasticsearch/issues/23486) and being able to use new features for managing the fleet.
+- The root disk size will now be `20 GB` on all nodes. Previously this was the case for OpenStack and DigitalOcean nodes, but for AWS the root disk size was the EC2 default of `8 GB`. For some Hypernodes this caused issues at peak moments when the access logs would be written to so fast that the log rotation couldn’t keep up. In the future this should be less of an issue because now there will be more space available. If you encounter such issues still with this increased capacity you can consider things like putting your [MySQL temporary directory on the /data disk](https://changelog.hypernode.com/changelog/release-5133-configurable-mysql-temporary-directory-extra-space/) in order to free up some more space.
+- TLS 1.3 has been added. Note that TLS 1.1 and TLS 1.0 are deprecated and will be disabled at a later point in time. You can already enable a stricter cipher suite [using the hypernode-api](https://community.hypernode.io/#/Documentation/hypernode-api/settings/README).
+- Curl has been updated to support and prefer HTTP/2. This may cause a problem if you use outdated Magento/Zend core libraries that can't interpret HTTP/2. If this is the case, you should modify your code to explicitly ask for a supported version. If you're using curl, you can do so by using something akin to:
+  - ```
+    ```
+  curl_setopt(\$ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+  ```
+  ```
+- The OpenSSL seclevel has been updated to from '1' to '2'. This may reduce interoperability with older systems that are using pre-2013 industry standards. If this is the case you can downgrade your TLS settings using the command
+  - ```
+    ```
+  hypernode-systemctl settings support_insecure_legacy_tls_enabled True
+  ```
+
+  ```
+
+## Checking if a Hypernode Has Been Upgraded Yet
+
+You can check the [message of the day](<https://en.wikipedia.org/wiki/Motd_(Unix)>) when you log in with ssh as it displays the `OS`, or run `lsb_release -a` or `cat /etc/os-release`. Alternatively you can check using [screenfetch](https://github.com/ByteInternet/screenfetch). On Buster you’ll see the Hypernode bot, on Xenial the package is not installed and the command is not available.
 
 ![](_res/z_0texfHpbx0Va8zij4vf_0Rwn7BVy-vKg.png)

docs/about-hypernode/about-hypernode/what-kind-of-emails-does-hypernode-send.md

@@ -1,29 +1,25 @@
 <!-- source: https://support.hypernode.com/en/about/about-us/what-kind-of-emails-does-hypernode-send/ -->
+
 # What Kind of Emails Does Hypernode Send
 
 Hypernode sends out different types of emails. Some of them we send to our customers only (ServiceMail), others contain product related information (ProductMail) or include interesting information about our Hypernode platform and fun facts about our company (NewsMail).
 
-
-ServiceMail
------------
+## ServiceMail
 
 We only send ServiceMails to our active customers. ServiceMails contain information about the specific products and services we deliver to you. You cannot unsubscribe from these emails because missing this important information may be harmful to you or the products you have. It is necessary for us to inform you well in order to serve you well. ServiceMails are – for example – an order confirmation, information about your customer account, a maintenance heads-up or information on the status of your shop or Hypernode.
 
-ProductMail
------------
+## ProductMail
 
 We continuously improve our Hypernode platform and services. Information about releases and changes can be found in our support documentation and [Changelog](https://support.hypernode.com/category/changelog/). In our ProductMail we present you the most interesting Hypernode releases in one email. On average you receive 1 ProductMail per month.
 
 We highly recommend you to subscribe to our ProductMail and never miss an update on Hypernode. Of course each ProductMail shows the option to unsubscribe.
 
-NewsMail
---------
+## NewsMail
 
 Once a month we send subscribers a NewsMail. Our NewsMail is an interesting mix of blog articles, news about Magento, Shopware, Akeneo and fun facts about our company. In our NewsMail you can read about the latest developments. We also often provide handy tips, information about patches and warnings for security issues.
 
 The NewsMail also keeps you informed of what is happening behind the scenes of our company. If you no longer wish to receive our NewsMail, you can unsubscribe at any time.
 
-Privacy Policy
---------------
+## Privacy Policy
 
 We take all necessary measures to keep your data private. Not because we are legally bound to do so, but because we care. We use your email address and other personal information solely to maintain our customer relationship with you. Your personal details will never be lent, rented or sold by Hypernode to third parties, nor made public in any other way, unless the law prescribes this. You can read our complete Privacy Policy on [our website](https://www.hypernode.com/assets/documents/Privacy-Policy-Hypernode.pdf).