From 63c5ba475dc003988ce1727fa126c9ba60e0cfe0 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Wed, 16 Dec 2020 23:24:53 +1000 Subject: [PATCH] feat(CI): add Markdown link checker - Checks for dead links in Markdown files - First run will check all files and then we will have a list of dead links - Then we can set it up to only run on files added in the PR - Fix links - Fix Markdown heading --- .github/workflows/markdown-link-checker.yml | 15 ++++++ .../transaction/_attributes/isolation.md | 2 +- .../string/parsedatetime/_arguments/format.md | 2 +- .../02.newbie-questions/page.md | 2 +- .../22.Extension-Installation/page.md | 2 +- docs/04.guides/04.cookbooks/chapter.md | 2 +- docs/04.guides/10.get-involved/chapter.md | 2 +- .../13.Various/04.Amf-configuration/page.md | 4 +- docs/06.docs/chapter.md | 2 +- mlc_config.json | 51 +++++++++++++++++++ 10 files changed, 75 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/markdown-link-checker.yml create mode 100644 mlc_config.json diff --git a/.github/workflows/markdown-link-checker.yml b/.github/workflows/markdown-link-checker.yml new file mode 100644 index 000000000..a2a79c5c9 --- /dev/null +++ b/.github/workflows/markdown-link-checker.yml @@ -0,0 +1,15 @@ +name: ๐Ÿ€ Markdown Link Check + +on: [pull_request] + +jobs: + markdown-link-check: + name: ๐Ÿงน Check Links + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'no' + check-modified-files-only: 'yes' diff --git a/docs/03.reference/02.tags/transaction/_attributes/isolation.md b/docs/03.reference/02.tags/transaction/_attributes/isolation.md index 06b0fed00..8c9143e5b 100644 --- a/docs/03.reference/02.tags/transaction/_attributes/isolation.md +++ b/docs/03.reference/02.tags/transaction/_attributes/isolation.md @@ -6,4 +6,4 @@ Database lock type. - serializable - none - \ No newline at end of file + \ No newline at end of file diff --git a/docs/03.reference/05.objects/string/parsedatetime/_arguments/format.md b/docs/03.reference/05.objects/string/parsedatetime/_arguments/format.md index e610b3042..95bcb1cb3 100644 --- a/docs/03.reference/05.objects/string/parsedatetime/_arguments/format.md +++ b/docs/03.reference/05.objects/string/parsedatetime/_arguments/format.md @@ -1,3 +1,3 @@ The format (Java Syntax) of the string. This string is used to parse the given date string to date time object. -For details see [[function-ParseDateTime]] or +For details see [[function-ParseDateTime]] or diff --git a/docs/04.guides/01.getting-started/02.newbie-questions/page.md b/docs/04.guides/01.getting-started/02.newbie-questions/page.md index f12145b9a..757d01b10 100644 --- a/docs/04.guides/01.getting-started/02.newbie-questions/page.md +++ b/docs/04.guides/01.getting-started/02.newbie-questions/page.md @@ -8,7 +8,7 @@ visible: 'false' These instructions assume you know how to set up DNS, port forwarding for your router, and how to add a new site in IIS. -1) Install Lucee [[https://lucee.org/downloads.html]] +1) Install Lucee [https://lucee.org/downloads.html](https://lucee.org/downloads.html) 2) Verify that Lucee is running (The internal IP of my Lucee server is 192.168.1.80, so I went to to view the Hello Lucee page, which verified a successful deployment) diff --git a/docs/04.guides/04.cookbooks/22.Extension-Installation/page.md b/docs/04.guides/04.cookbooks/22.Extension-Installation/page.md index 296aa2d4b..37fda000d 100644 --- a/docs/04.guides/04.cookbooks/22.Extension-Installation/page.md +++ b/docs/04.guides/04.cookbooks/22.Extension-Installation/page.md @@ -19,7 +19,7 @@ Extensions can be installed via the web or server admin. If you want to use the It available in **Extension -> Applications** -![Extension](assets/images/screenImages/Extension.png) +![Extension](assets/images/screenImages/extension.PNG) Here we you can see the extension which is installed and not installed. diff --git a/docs/04.guides/04.cookbooks/chapter.md b/docs/04.guides/04.cookbooks/chapter.md index 2e3b4f982..63422d279 100644 --- a/docs/04.guides/04.cookbooks/chapter.md +++ b/docs/04.guides/04.cookbooks/chapter.md @@ -9,7 +9,7 @@ Some basic examples * [[cookbook-basic-date]] -## Application.cfc / Tag ## +## Application.cfc / Tag `` ## Lucee comes with a simple framework that let's you control the flow of your application and your environment with a file named "Application.cfc". diff --git a/docs/04.guides/10.get-involved/chapter.md b/docs/04.guides/10.get-involved/chapter.md index 38a9f6cf8..52157160c 100644 --- a/docs/04.guides/10.get-involved/chapter.md +++ b/docs/04.guides/10.get-involved/chapter.md @@ -9,4 +9,4 @@ Get involved in the Lucee Project! * [Contribute](https://github.com/lucee/Lucee/) to the code * Engage with other Lucee community members via our [Mailing List](https://dev.lucee.org/) * [Submit](https://luceeserver.atlassian.net/) bugs and feature requests -* [Become a supporter](https://lucee.org/supporters/become-a-supporter.html) +* [Become a supporter](https://www.lucee.org/members.html) diff --git a/docs/04.guides/13.Various/04.Amf-configuration/page.md b/docs/04.guides/13.Various/04.Amf-configuration/page.md index e859b19dc..968628ed2 100644 --- a/docs/04.guides/13.Various/04.Amf-configuration/page.md +++ b/docs/04.guides/13.Various/04.Amf-configuration/page.md @@ -4,13 +4,13 @@ id: amf-configuration --- ## BlazeDS 3.2 integration ## -Lucee 3.x comes with BlazeDS 3.2, the Adobe opensource amf engine to communicate from a Flex application to a Java backend. Using AMF has a lot of advantages over the usage of REST or SOAP, if you need more information about BlazeDS please take a look at the documentation on . +Lucee 3.x comes with BlazeDS 3.2, the Adobe opensource amf engine to communicate from a Flex application to a Java backend. Using AMF has a lot of advantages over the usage of REST or SOAP, if you need more information about BlazeDS please take a look at the documentation on . The following is a short explanation about how to use BlazeDS with Lucee. First we start with an overall description about how to setup BlazeDS and how to test that it works, later down we will look at the different Lucee versions (Express, Server etc) and where you can find the individual pieces of the BlazeDS setup for your Lucee of choice. This text is based on Lucee 3.1.2, but should apply also to future versions of Lucee 3.x. It could change slightly for Lucee 4 though. ### Overall setup of BlazeDS ### -The different versions of Lucee come with slightly different preparations of the following, but to get an overview we start with a standard BlazeDS/Java setup. You can test this without Lucee, just download the blazeds.war file from , unzip it and copy it on the Java server of your choice. For example with tomcat you would put the unzipped blazeds directory into the webapps folder. In the following examples we will call this directory the /app-root directory. +The different versions of Lucee come with slightly different preparations of the following, but to get an overview we start with a standard BlazeDS/Java setup. You can test this without Lucee, just download the blazeds.war file from , unzip it and copy it on the Java server of your choice. For example with tomcat you would put the unzipped blazeds directory into the webapps folder. In the following examples we will call this directory the /app-root directory. To be able to use BlazeDS, we need to run the MessageBroker Servlet on the Java server. This can be achieved by putting the following code into the /app-root/WEB-INF/web.xml file: diff --git a/docs/06.docs/chapter.md b/docs/06.docs/chapter.md index 338567a34..0f52af6f1 100644 --- a/docs/06.docs/chapter.md +++ b/docs/06.docs/chapter.md @@ -18,7 +18,7 @@ Good documentation is at the heart of all successful open source projects. With This documentation is built from an open source repository that is open to all to contribute. The repository can be found under the official Lucee team's GitHub account at [https://github.com/lucee/lucee-docs](https://github.com/lucee/lucee-docs). -You'll find information on ways in which you can contribute in the [[docs-content]] and [[docs-build]] sections. However, if you're ever in doubt, we encourage you to use the [issue tracker](https://luceeserver.atlassian.net/projects/LD) and [community forums](https://lucee.org/get-involved.html) to help get you started or discuss your ideas. +You'll find information on ways in which you can contribute in the [[docs-content]] and [[docs-build]] sections. However, if you're ever in doubt, we encourage you to use the [issue tracker](https://luceeserver.atlassian.net/projects/LD) and [community forums](https://dev.lucee.org/) to help get you started or discuss your ideas. ## Technology diff --git a/mlc_config.json b/mlc_config.json new file mode 100644 index 000000000..23a3c2827 --- /dev/null +++ b/mlc_config.json @@ -0,0 +1,51 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http:\/\/127.0.0.1.*" + }, + { + "pattern": "http:\/\/192.168.*" + }, + { + "pattern": "https:\/\/cdn.lucee.org/{version-number}.*" + }, + { + "pattern": "http:\/\/{hostname}.*" + }, + { + "pattern": "http:\/\/\\$host:\\$port.*" + }, + { + "pattern": "http:\/\/localcontext.*" + }, + { + "pattern": "^http:\/\/localhost.*" + }, + { + "pattern": "http:\/\/(www.)?mysite.com.*" + }, + { + "pattern": "http:\/\/svlucee01.netfusion.local.*" + }, + { + "pattern": "^http:\/\/yourdomain.*" + }, + { + "pattern": "http:\/\/www.servername.com.*" + } + ], + "replacementPatterns": [ + { + "pattern": "^assets", + "replacement": "https:\/\/docs.lucee.org\/assets" + }, + { + "pattern": "^\/images", + "replacement": "https:\/\/docs.lucee.org\/images" + }, + { + "pattern": "^\/guides", + "replacement": "https:\/\/docs.lucee.org\/guides" + } + ] +}