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

Renaming paths or files in xref'd repo leads to 404 #5

Open
kordwarshuis opened this issue Jun 13, 2024 · 4 comments
Open

Renaming paths or files in xref'd repo leads to 404 #5

kordwarshuis opened this issue Jun 13, 2024 · 4 comments
Assignees
Labels
enhancement New feature or request Study The result is a report of a an investigation

Comments

@kordwarshuis
Copy link

Scenario:

  • link to term in external reference via “[[xref: term]]
  • term in external reference is renamed (from “term-1.md” to “example-term-1.md”) or path to “term-1.md” is renamed (from “terms-definitions/term-1.md” to “terms-and-definitions/term-1.md”
  • xref does not work anymore
@kordwarshuis
Copy link
Author

To do: Test linking to file version with commit hash.

@henkvancann
Copy link

henkvancann commented Jun 14, 2024

Although it's ugly, we could also add a governance constraint: If you ever change a definition, then add:

[[def:oldterm]] 
~ [[ref:newterm]]

Other solutions like adding a .htaccess forwarder might be neater. Or maybe even an xref to a synonym might work. So then the {oldterm} could be added to the list of synonyms. Therefore:

To do: Test linking to file version with commit hash.

To do 2: We would also like to test whether xref to synonym works

@kordwarshuis
Copy link
Author

Although it's ugly, we could also add a governance constraint: If you ever change a definition, then add:

Other solutions like adding a .htaccess forwarder might be neater.

This is when an external reference changes, so it is outside our governance.

@kordwarshuis kordwarshuis self-assigned this Aug 22, 2024
@kordwarshuis kordwarshuis added the enhancement New feature or request label Aug 22, 2024
@henkvancann
Copy link

This is when an external reference changes, so it is outside our governance. ->
Yes, I understand. But you'd have control over this:

[[xref:term , example-term, another-alias-term]] when term has changed into example-term out of your control, but you could still investigate the host github repo to see what happened and adjust your xref accordingly?

@henkvancann henkvancann changed the title Renaming paths or files in xref repo leads to 404 Renaming paths or files in xref'd repo leads to 404 Aug 27, 2024
@henkvancann henkvancann added Study The result is a report of a an investigation bug Something isn't working enhancement New feature or request and removed enhancement New feature or request bug Something isn't working labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Study The result is a report of a an investigation
Projects
None yet
Development

No branches or pull requests

2 participants