Skip to content

Commit

Permalink
Update 0011-test-external-links-in-documentation.md (#12006)
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor authored Oct 17, 2024
1 parent 8b43128 commit a2122bd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/decisions/0011-test-external-links-in-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ For high-quality documentation, external links should be working.

## Decision Outcome

Chosen option: "\[option 1\]", because \[justification. e.g., only option, which meets k.o. criterion decision driver \| which resolves force force \|\| comes out best \(see below\)\].
Chosen option: "Check external links once a month", because it provides a basic quality baseline.

### Positive Consequences

* Automatic notification of broken external links

### Negative Consequences

* Some external sites need to [be disabled](https://github.com/JabRef/jabref/pull/6542/files). For instance, GitHub.com always returns "forbidden". A [filter for status is future work of the used tool](https://github.com/tcort/markdown-link-check/issues/94#issuecomment-634947466).
* Some external sites need to [be disabled](https://github.com/JabRef/jabref/pull/6542/files). For instance, GitHub.com always returns "forbidden".
* Contributors find it strange if external links are broken (example: [user-documentation#526](https://github.com/JabRef/user-documentation/pull/526#issuecomment-2416462977))

## Pros and Cons of the Options

Expand Down

0 comments on commit a2122bd

Please sign in to comment.