Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FLUID-5629: fix URLs #269

Merged
merged 7 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
.cache
_site
node_modules
2 changes: 1 addition & 1 deletion License.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
http://creativecommons.org/licenses/by/3.0/
https://creativecommons.org/licenses/by/3.0/

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

## Browse the Infusion Documentation

You can [browse the Infusion Documentation website](http://docs.fluidproject.org/infusion/), or if
You can [browse the Infusion Documentation website](https://docs.fluidproject.org/infusion/), or if
you prefer, you can [browse the source documentation files directly on GitHub](src/documents).

## Working with the Infusion Documentation locally

You must have [Node and NPM](https://nodejs.org/en/download/) installed in order to work on the Infusion Documentation
You must have [Node and NPM](https://nodejs.org/en/download/package-manager) installed in order to work on the Infusion Documentation
locally (the LTS version is recommended).

To install the dependencies for this project:
Expand All @@ -34,7 +34,7 @@ npm run build

## Deploying the Infusion Documentation website

The [Infusion Documentation website](http://docs.fluidproject.org/infusion/) is published with [Netlify](https://netlify.com)
The [Infusion Documentation website](https://docs.fluidproject.org/infusion/) is published with [Netlify](https://netlify.com)
every time new content is pushed to the `main` branch of this repository. [Deploy previews](https://docs.netlify.com/site-deploys/overview/#deploy-preview-controls)
are also generated for every pull request. For more information, please review Netlify's [documentation](https://docs.netlify.com).

Expand All @@ -47,7 +47,7 @@ Once you have Docker installed, run the following commands to build a Docker ima
* Build the image: `docker build -t infusion-docs .`
* Run the container: `docker run --name infusion-docs -p 8000:80 infusion-docs`

The documentation will be available at [http://localhost:8000](http://localhost:8000)
The documentation will be available at <http://localhost:8000>

* To stop and remove the container: `docker rm -f infusion-docs`

Expand Down
8 changes: 8 additions & 0 deletions eleventy.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

var githubSlugify = require("github-slugger").slug;
var {exec} = require("child_process");
const brokenLinksPlugin = require("eleventy-plugin-broken-links");

require("./index.js");
var hljs = require("highlight.js");
Expand Down Expand Up @@ -42,6 +43,13 @@ module.exports = function (eleventyConfig) {
eleventyConfig.addTransform("parse", parseTransform);

eleventyConfig.addPlugin(navigationPlugin);
eleventyConfig.addPlugin(brokenLinksPlugin, {
forbidden: "error",
broken: "error",
// Codepen links return 403
// see: https://github.com/bradleyburgess/eleventy-plugin-broken-links/issues/9
excludeUrls: ["https://codepen.io*"]
});

eleventyConfig.addPassthroughCopy({
"node_modules/infusion/dist": "lib/infusion/dist",
Expand Down
Loading
Loading