Skip to content

Commit

Permalink
feat(CI): add Markdown link checker
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
jbampton committed Dec 17, 2020
1 parent 7e6ecd0 commit 63c5ba4
Show file tree
Hide file tree
Showing 10 changed files with 75 additions and 9 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/markdown-link-checker.yml
Original file line number Diff line number Diff line change
@@ -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'
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Database lock type.
- serializable
- none

<https://en.wikipedia.org/wiki/Isolation_(database_systems)]>
<https://en.wikipedia.org/wiki/Isolation_(database_systems)>
Original file line number Diff line number Diff line change
@@ -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 <https://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html>
For details see [[function-ParseDateTime]] or <https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html>
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://192.168.1.80:8888> to view the Hello Lucee page, which verified a successful deployment)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/04.guides/04.cookbooks/chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Some basic examples

* [[cookbook-basic-date]]

## Application.cfc / Tag <cfapplication> ##
## Application.cfc / Tag `<cfapplication>` ##

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".

Expand Down
2 changes: 1 addition & 1 deletion docs/04.guides/10.get-involved/chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/04.guides/13.Various/04.Amf-configuration/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://opensource.adobe.com/wiki/display/blazeds/Developer+Documentation>.
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 <https://sourceforge.net/adobe/blazeds/wiki/Developer%20Documentation/>.

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 <https://opensource.adobe.com/wiki/display/blazeds/Downloads>, 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 <https://sourceforge.net/adobe/blazeds/wiki/Downloads>, 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:

Expand Down
2 changes: 1 addition & 1 deletion docs/06.docs/chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
51 changes: 51 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
}

0 comments on commit 63c5ba4

Please sign in to comment.