Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

links between ADR's are not working in generated site #260

Closed
UBessle opened this issue Jul 6, 2023 · 2 comments · Fixed by #284
Closed

links between ADR's are not working in generated site #260

UBessle opened this issue Jul 6, 2023 · 2 comments · Fixed by #284
Labels
bug Something isn't working

Comments

@UBessle
Copy link
Contributor

UBessle commented Jul 6, 2023

Structurizr-site-generatr supports ADR's as part of the architecture documentation for the workspace as well as for systems and even containers.

ADR support is already part of structurizr, where it's states, that the format proposed by adr-tools from Michael Nygard should be used for these ADR files (https://structurizr.com/help/decision-log).

Part of the formating rules for ADR files is the definition how ADR's may be linked to each other, because a later ADR could replace or amend an earlier one. You find an example in the adr-tools repository, where ADR 0005-help-comments.md is amended by ADR 0009-help-scripts.md.

Unfortunately these links do not work in the generated site from structurizr-site-generatr.

How to reproduce the problem

  • install adr-tools if they are not yet available
  • cd to docs/example from structurizr-site-generatr
  • adr new Use MySQL Database
    creates workspace-adrs/0002-use-mysql-database.md
  • adr new -s 2 Use PostgreSQL Database
    creates workspace-adrs/0003-use-postgresql-database.md

Content of workspace-adrs/0003-use-postgresql-database.md will be

# 3. Use PostgreSQL Database

Date: 2023-07-06

## Status

Accepted

Supercedes [2. Use MySQL Database](0002-use-mysql-database.md)

## Context

The issue motivating this decision, and any context that influences or constrains the decision.

## Decision

The change that we're proposing or have agreed to implement.

## Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
@MartinC-MCN
Copy link

Can confirm I have the same issue. Could not find a way around it without specifying explicitly the absolute URL, which would in turn break the actual link between the 2 markdowns outside of the context of the website

dirkgroot added a commit that referenced this issue Aug 11, 2023
dirkgroot added a commit that referenced this issue Aug 11, 2023
@dirkgroot dirkgroot added the bug Something isn't working label Aug 11, 2023
@dirkgroot
Copy link
Collaborator

@UBessle Thanks for reporting this issue. I've created #284 to fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants