Skip to content

Commit aa9f768

Browse files
Add an ADR about changing URLS
Add an ADR justifying the change to long-form URLs
1 parent 2a846a2 commit aa9f768

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 21. Use long-form URLs in documentation
2+
3+
Date: 2025-05-07
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Copier supports shortcut URLs (see [docs](https://copier.readthedocs.io/en/stable/generating)) of the form `gh:namespace/project`. This was convenient for making our documentation look neater and more digestible to new users, however it is just a convention. When trying to integrate other tools with copier we find that they do not necessarily support the convention. See [this discussion](https://github.com/renovatebot/renovate/discussions/35577) for example.
12+
13+
## Decision
14+
15+
Remove shortcut URLs from this repository and replace them with standard URLs.
16+
17+
## Consequences
18+
19+
Downstream projects following the documentation will be created with standard URLs and will be supported by renovate and other tools. The alternative solution is to open PRs to these tools so they too support the shortcuts. It was decided that it was quicker, easier and probably more architecturally correct to use long-form URLs since they are already a well-known and widely adopted standard. See [this discussion](https://github.com/epics-containers/services-template-helm/issues/21#issuecomment-2855125741).

0 commit comments

Comments
 (0)