Merged
Conversation
When we updated the docs site, we set up redirects for all of these links, so they were still working, but it is time to properly update the links everywhere.
In the new user guide, there is no separate page for cross-referencing anymore. Instead, cross-referencing is mentioned as part of the docs article "Generating entities from a spreadsheet", so this link is redundant.
Previously, this linked to the developer docs about mappings. As this link is displayed in the Aleph UI, it makes more sense to link to the end user guide.
tillprochaska
force-pushed
the
fix/documentation-links
branch
from
a31b79b to
3507888
Compare
Rosencrantz
approved these changes
Apr 4, 2024
| Aleph is commonly used to import data tables \(like a companies registry, list of persons of interest, or a set of government contracts\) that a user wants to search and browse. | ||
|
|
||
| It does this by mapping tabular source data to the [Follow the Money](https://docs.alephdata.org/developers/followthemoney) \(FtM\) data model. Aleph defines entities \(such as `People`, `Companies`, `Assets` or `Court Cases`\), and the relationships between them \(such as `Family`relations, or business interests – `Ownership` or `Directorship`, or other links like `Sanctions`, `Payments` \). | ||
| It does this by mapping tabular source data to the [Follow the Money](/developers/followthemoney) \(FtM\) data model. Aleph defines entities \(such as `People`, `Companies`, `Assets` or `Court Cases`\), and the relationships between them \(such as `Family`relations, or business interests – `Ownership` or `Directorship`, or other links like `Sanctions`, `Payments` \). |
Contributor
There was a problem hiding this comment.
@tillprochaska This is ok without the domain? I notice this a few times in the changes you've made, I assume that it is ok, but wanted to check and be sure
Contributor
Author
There was a problem hiding this comment.
Thanks for being thorough! For internal links this is actually the preferred way for two reasons:
- It doesn’t break when we change the domain.
- We run an automated link checker in CI that checks that we don’t have broken internal links (here’s an example), but the link checker doesn’t work for external links/absolute URLs.
Contributor
Author
There was a problem hiding this comment.
Argh, but I’ve actually made one mistake and also used a relative URL in a Markdown file for the page at https://aleph.occrp.org/pages/faq where this doesn’t work. I’ll fix this shortly
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When we updated the docs site, we set up redirects for all of these links, so they were still working, but it is time to properly update the links everywhere.
This also updates a few links to the user guide from within the Aleph UI, so I won’t merge this directly into
mainas I usually do with documentation changes, but instead follow the normal release process for code changes.One of the CI workflows is currently failing -- I’ve fixed this in #3670 and will rebase this branch as soon as the fix is merged.