Skip to content
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
3 changes: 0 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ yarn validate
# Lint prose in AsciiDoc files
yarn prose

# Check for broken links (requires built site)
yarn linkcheck

# Serve the built docs locally at http://localhost:8080
yarn serve
```
Expand Down
5 changes: 3 additions & 2 deletions agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cu
- **Product family:** Documentation
- **Primary language(s):** JavaScript
- **Build system:** npm (Antora)
- **Test framework:** broken-link-checker
- **Test framework:** Antora build (`npm run antora`); link checking is documented in `docs/checking-broken-links.md`
- **CI system:** GitHub Actions

## Architecture & Key Paths
Expand All @@ -33,7 +33,8 @@ This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cu
npm run antora

# Test
npm run linkcheck
# No automated test suite; verify by building (npm run antora).
# Link checking is documented in docs/checking-broken-links.md.

# Lint
Not detected (Prettier config present for formatting)
Expand Down
24 changes: 1 addition & 23 deletions docs/checking-broken-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To check broken links, you need to prepare with the following steps:
1. Make the compiled documentation available for browsing by using a webserver like
[our npm target](./build-the-docs.md#viewing-the-html-documentation), [PHP's built-in webserver](https://secure.php.net/manual/en/features.commandline.webserver.php), Apache or NGINX
2. Build the local docs with ``npm antora --url http://localhost:8080``
3. Use an already provided or install a Broken Link Checker
3. Install a Broken Link Checker of your choice (see the examples below)

Use the broken link checker of your choice, the following are usable examples. The command examples assume that the documentation built is accessible via `http://localhost:8080`.

Expand Down Expand Up @@ -59,28 +59,6 @@ worktree: /var/www/owncloud/docs | component: server | version: master
path: modules/admin_manual/pages/configuration/files/file_sharing_configuration.adoc | xref: server/configuration/server/security/password_policy.adoc
```

### npm Linkcheck

If you installed the Antora dependencies via `npm install`, then a broken link checker is available. To run it, you must have one terminal open and run `npm serve` to start a http server and in another terminal using the following command:

```console
npm linkcheck http://localhost:8080/server/next | grep "BROKEN"
```

#### Example Output

```console
...
├─BROKEN─ http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/ (BLC_UNKNOWN)
├─BROKEN─ http://bucket.hostname.domain/ (ERRNO_ENOTFOUND)
├─BROKEN─ http://hostname.domain/bucket (ERRNO_ENOTFOUND)
├─BROKEN─ https://example.com/owncloud (HTTP_404)
├─BROKEN─ https://example.com/owncloud (HTTP_404)
...
```
Note: in the example output above, only the first entry is a genuine broken link.
All the others in the list are example links, and therefore not broken.

## Publicly Available Linkcheckers

### htmltest by Will Pimblett
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Next, you need to learn how to [build the docs](./build-the-docs.md) from the co

#### Broken Link Checker

To check for broken links manually, see [install and use a broken-link-checker](./checking-broken-links.md).
To check for broken links manually, see [install and use a broken link checker](./checking-broken-links.md).

### Contributing to the Documentation

Expand Down
Loading