Skip to content

Commit d0ea3db

Browse files
authored
Adjust FAQ Slack link + dead link checker (k3s-io#61)
* Adjust slack link * Add external link checker * Fix dead external links Signed-off-by: Derek Nola <[email protected]>
1 parent 317d6fc commit d0ea3db

File tree

7 files changed

+278
-9
lines changed

7 files changed

+278
-9
lines changed

.github/workflows/test-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ jobs:
1818

1919
- name: Install dependencies
2020
run: yarn install --frozen-lockfile
21-
- name: Check internal links
22-
run: yarn run remark --quiet --frail ./docs
21+
- name: Check links
22+
run: yarn run remark --use remark-lint-no-dead-urls --use remark-validate-links --frail ./docs
2323
- name: Test build website
2424
run: yarn build
2525

docs/advanced/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ There are several ways to run K3s in Docker:
279279
<Tabs>
280280
<TabItem value='K3d' default>
281281
282-
[k3d](https://github.com/k3s-io/k3d) is a utility designed to easily run K3s in Docker.
282+
[k3d](https://github.com/k3d-io/k3d) is a utility designed to easily run K3s in Docker.
283283
284284
It can be installed via the the [brew](https://brew.sh/) utility on MacOS:
285285

docs/faq/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ If you are having an issue with deploying K3s, you should:
5353

5454
3) Search the [K3s GitHub existing issues](https://github.com/k3s-io/k3s/issues) for one that matches your problem.
5555

56-
4) Join the [Rancher K3s Slack](https://rancher-users.slack.com/archives/CGGQEHPPW) channel to get help.
56+
4) Join the [Rancher Slack](https://rancher-users.slack.com/) K3s channel to get help.
5757

5858
5) Submit a [New Issue](https://github.com/k3s-io/k3s/issues/new/choose) on the K3s Github describing your setup and the issue you are experiencing.

docs/installation/network-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You should see that IP forwarding is set to true.
7878
</TabItem>
7979
<TabItem value="Calico" default>
8080

81-
Follow the [Calico CNI Plugins Guide](https://docs.projectcalico.org/master/docs/reference/cni-plugin/configuration). Modify the Calico YAML so that IP forwarding is allowed in the `container_settings` section, for example:
81+
Follow the [Calico CNI Plugins Guide](https://projectcalico.docs.tigera.io/reference/cni-plugin/configuration). Modify the Calico YAML so that IP forwarding is allowed in the `container_settings` section, for example:
8282

8383
```yaml
8484
"container_settings": {

docs/reference/binary-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Command | Description
99
--------|------------------
1010
`k3s server`| Run the K3s management server, which will also launch Kubernetes control plane components such as the API server, controller-manager, and scheduler.
1111
`k3s agent`| Run the K3s node agent. This will cause K3s to run as a worker node, launching the Kubernetes node services `kubelet` and `kube-proxy`.
12-
`k3s kubectl`| Run an embedded [kubectl](https://kubernetes.io/docs/docs/reference/kubectl/overview/) CLI. If the `KUBECONFIG` environment variable is not set, this will automatically attempt to use the config file that is created at `/etc/rancher/k3s/k3s.yaml` when launching a K3s server node.
12+
`k3s kubectl`| Run an embedded [kubectl](https://kubernetes.io/docs/reference/kubectl) CLI. If the `KUBECONFIG` environment variable is not set, this will automatically attempt to use the config file that is created at `/etc/rancher/k3s/k3s.yaml` when launching a K3s server node.
1313
`k3s crictl`| Run an embedded [crictl](https://github.com/kubernetes-sigs/cri-tools/blob/master/docs/crictl.md). This is a CLI for interacting with Kubernetes's container runtime interface (CRI). Useful for debugging.
1414
`k3s ctr`| Run an embedded [ctr](https://github.com/projectatomic/containerd/blob/master/docs/cli.md). This is a CLI for containerd, the container daemon used by K3s. Useful for debugging.
1515
`k3s etcd-snapshot` | Perform on demand backups of the K3s cluster data and upload to S3. See [Backup and Restore](../backup-restore/backup-restore.md#backup-and-restore-with-embedded-etcd-datastore) for more information.

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
"react": "^17.0.2",
2323
"react-dom": "^17.0.2",
2424
"remark-cli": "^11.0.0",
25+
"remark-lint": "^9.1.1",
26+
"remark-lint-no-dead-urls": "^1.1.0",
2527
"remark-validate-links": "^12.1.0"
2628
},
2729
"devDependencies": {

0 commit comments

Comments
 (0)