diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b00823c443..e5afefa773 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -9,7 +9,6 @@ on: - 'docs/**' jobs: test: - if: false runs-on: ubuntu-latest name: Test Documentation links steps: @@ -24,7 +23,6 @@ jobs: - name: Test Documentation Links run: npm run test:docs test-with-website: - if: false runs-on: ubuntu-latest name: Test Documentation with website steps: diff --git a/docs/device-agent/deploy.md b/docs/device-agent/deploy.md index b24217f610..dfef8fb464 100644 --- a/docs/device-agent/deploy.md +++ b/docs/device-agent/deploy.md @@ -43,7 +43,7 @@ When running in the default of Fleet Mode, the device agent does not allow local Node-RED editor. This ensures the Remote Instance is running the deployed snapshot without modification. When running on FlowFuse Cloud, or a premium licensed FlowFuse instance (with the -[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-(optional))) +[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-optional)) the Remote Instance can be placed in Developer Mode that enables remote access to the editor. This can then be used to develop the flows directly on the Remote Instance and a new snapshot @@ -72,7 +72,7 @@ Access to the editor is only available when: * The Remote Instance is in Developer Mode * When running on FlowFuse Cloud, or a premium licensed FlowFuse instance (with the -[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-(optional)) +[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-optional) the Remote Instance can be placed in Developer Mode that enables remote access to the editor. * Local access to the editor can be enabled by defining a Username & Password in the Device diff --git a/docs/install/docker/README.md b/docs/install/docker/README.md index 50729d5313..4a95090a51 100644 --- a/docs/install/docker/README.md +++ b/docs/install/docker/README.md @@ -91,7 +91,7 @@ Before you begin, ensure you have the following: For a production-ready environment, we also recommend: * **Database:** Prepare dedicated database on a external database server (see [FAQ](#how-to-use-external-database-server%3F) for more details) -* **TLS Certification:** Prepare TLS certificate for your domain and configure FlowFuse platform to use it (see [Enable HTTPS](#enable-https-(optional))) +* **TLS Certification:** Prepare TLS certificate for your domain and configure FlowFuse platform to use it (see [Enable HTTPS](#enable-https-optional)) ### Requirements @@ -291,7 +291,7 @@ Once ready, [start the application](#start-flowfuse-platform) . ### How can I provide my own TLS certificate? -If you have your own TLS certificate, you can use it in FlowFuse platform installation as well. See [Enable HTTPS](#enable-https-(optional)) section for more details. +If you have your own TLS certificate, you can use it in FlowFuse platform installation as well. See [Enable HTTPS](#enable-https-optional) section for more details. Additionally, if your TLS certificate is issued by a private Certificate Authority, you will need to perform some additional configuration to make hosted Node-RED instances trust the CA. See [What additional configuration is required when the TLS certificate is issued by a private Certificate Authority](#what-additional-configuration-is-required-when-the-tls-certificate-is-issued-by-a-private-certificate-authority%3F) for the step-by-step instructions. diff --git a/docs/upgrade/README.md b/docs/upgrade/README.md index 97decaec8e..3fdc0b26ef 100644 --- a/docs/upgrade/README.md +++ b/docs/upgrade/README.md @@ -142,7 +142,7 @@ This release introduces an MQTT Broker into the FlowFuse platform used to commun between devices and the core platform. For LocalFS users, they will need to manually setup the broker and ensure it is -properly configured. The documentation for this is available [here](../contribute/local#setting-up-mosquitto-(optional)) +properly configured. The documentation for this is available [here](../contribute/local#setting-up-mosquitto-optional) #### LocalFS Users