Skip to content

Commit

Permalink
use markdownlinkcheck and fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
AshleyDumaine committed Apr 11, 2024
1 parent e33a36a commit e83425a
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 10 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,6 @@ jobs:
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/book'
- name: Check broken links
uses: ruzickap/action-my-broken-link-checker@v2
with:
url: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
pages_path: docs/book
cmd_params: '--buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --timeout=20'

deploy-page:
needs: generate-docs
Expand Down
28 changes: 28 additions & 0 deletions .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check for broken links

on:
push:
branches:
- '*'
paths:
- 'README.md'
- 'docs/**'

permissions:
contents: read

jobs:
markdown-link-check:
name: Broken Links
runs-on: ubuntu-latest
steps:
- name: Harden Runner
uses: step-security/harden-runner@v2
with:
egress-policy: audit

- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: .markdownlinkcheck.json
11 changes: 11 additions & 0 deletions .markdownlinkcheck.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"ignorePatterns": [
{ "pattern": "^https://www.linode.com" },
{ "pattern": "^https://linode.com" }
],
"timeout": "5s",
"retryOn429": true,
"retryCount": 5,
"fallbackRetryDelay": "30s",
"aliveStatusCodes": [200]
}
2 changes: 1 addition & 1 deletion docs/src/reference/reference.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Reference

For reference documentation for CAPL API types, please refer to
the [godocs](https://pkg.go.dev/github.com/linode/cluster-api-provider-linode@v0.0.0-20240201213736-1a737bd24eca/api/v1alpha1)
the [godocs](https://pkg.go.dev/github.com/linode/cluster-api-provider-linode)
4 changes: 3 additions & 1 deletion docs/src/topics/etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ The pod will need the bucket details like the name, region, endpoints and access
bucket-details secret that is created when the OBJ bucket gets created.

### Enabling SSE
Users can also enable SSE(Server_side encryption) by passing a SSE AES-256 Key as an env var. All env vars [here](../../../templates/addons/etcd-backup-restore/etcd-backup-restore.yaml) on the pod can be controlled during the provisioning process.
Users can also enable SSE (Server-side encryption) by passing a SSE AES-256 Key as an env var. All env vars
[here](https://github.com/linode/cluster-api-provider-linode/blob/main/templates/addons/etcd-backup-restore/etcd-backup-restore.yaml)
on the pod can be controlled during the provisioning process.

> [!WARNING]
> This is currently under development and will be available for use once the upstream [PR](https://github.com/gardener/etcd-backup-restore/pull/719) is merged and an official image is made available
Expand Down
2 changes: 1 addition & 1 deletion docs/src/topics/flavors/dual-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|---------------|--------|--------------|-----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | Yes |
## Prerequisites
[Quickstart](../topics/getting-started.md) completed
[Quickstart](../getting-started.md) completed
## Usage
1. Generate cluster yaml
```bash
Expand Down
2 changes: 1 addition & 1 deletion templates/flavors/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Flavors

## [Flavor usage documentation](https://linode.github.io/cluster-api-provider-linode/flavors/flavors.html)
## [Flavor usage documentation](https://linode.github.io/cluster-api-provider-linode/topics/flavors/flavors.html)

## Development

Expand Down

0 comments on commit e83425a

Please sign in to comment.