Skip to content

Commit 872089c

Browse files
Fix documentation links (#3667)
* Update documentation links to use docs.aleph.occrp.org domain 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. * Remove "Cross-referencing" docs link on investigations homepage 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. * Update user guide link in entity mapping UI 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.
1 parent 1f42d28 commit 872089c

File tree

13 files changed

+30
-45
lines changed

13 files changed

+30
-45
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ If you're trying to install Aleph and need help, or if you are running Aleph and
1616

1717
1. [Read the Aleph Support Policy](https://github.com/alephdata/aleph/blob/main/SUPPORT.md) and understand under what
1818
rules we provide support to others. If you feel you fall within that
19-
group, please [get in touch](https://docs.alephdata.org/get-in-touch).
19+
group, please [get in touch](https://docs.aleph.occrp.org/get-in-touch).
2020

21-
2. Make sure you've [read the documentation](https://docs.alephdata.org),
21+
2. Make sure you've [read the documentation](https://docs.aleph.occrp.org),
2222
especially the technical troubleshooting sections.
2323

2424
3. Only once you're **certain that the problem you are seeing is a bug**
@@ -30,7 +30,7 @@ If you're trying to install Aleph and need help, or if you are running Aleph and
3030

3131
A great place to start when looking for something to work on is our [project board](https://github.com/orgs/alephdata/projects/10). For experienced Aleph developers feel free to check our the [workboard](https://github.com/orgs/alephdata/projects/10/views/1). If this is your first time working on Aleph then it's probably a good idea to pick [something easy to work on](https://github.com/orgs/alephdata/projects/10/views/10). You can also find these issues on our [contribute page](https://github.com/alephdata/aleph/contribute). Regardless, once you've selected an issue please take a moment to assign it to yourself, this will stop anyone else from working on your issue.
3232

33-
If, after reviewing the list (or selecting an issue to work on) you'd like to reach out and talk to us then [get in touch](https://docs.alephdata.org/get-in-touch).
33+
If, after reviewing the list (or selecting an issue to work on) you'd like to reach out and talk to us then [get in touch](https://docs.aleph.occrp.org/get-in-touch).
3434

3535
### Forking and Branching
3636

README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ companies) against watchlists, e.g. from prior research or public datasets.
1515
For further details on the software, how to use it, install it or manage data
1616
imports, please check the documentation at:
1717

18-
* https://docs.alephdata.org
19-
* Installation: https://docs.alephdata.org/developers/installation
20-
* Changes: https://docs.alephdata.org/developers/changelog
18+
* https://docs.aleph.occrp.org
19+
* Installation: https://docs.aleph.occrp.org/developers/installation
2120

2221

2322
Support
@@ -28,7 +27,7 @@ If you're interested in participating in this process, please read the support
2827
policy (`SUPPORT.md`), the contribution rules (`CONTRIBUTING.md`), and the code of conduct (`CODE_OF_CONDUCT.md`) and then get
2928
in touch:
3029

31-
* https://docs.alephdata.org/get-in-touch
30+
* https://docs.aleph.occrp.org/get-in-touch
3231

3332
Release process
3433
---------------

aleph/pages/about.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ menu: true
66

77
Aleph is a powerful tool for people who follow the money. It helps investigators to securely access and search large amounts of data - no matter whether they are a government database or a leaked email archive.
88

9-
Please refer to the [documentation](https://docs.alephdata.org/) for more details.
9+
Please refer to the [documentation](https://docs.aleph.occrp.org/) for more details.

aleph/validation/spec.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858

5959
spec_docs = {
6060
"description": "Find out more about Aleph, a suite of data analysis tools for investigators.", # noqa
61-
"url": "https://docs.alephdata.org/",
61+
"url": "https://docs.aleph.occrp.org/",
6262
}
6363

6464
spec_tags = [

docs/src/pages/developers/mappings.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Importing structured data
1111

1212
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.
1313

14-
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` \).
14+
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` \).
1515

1616
To load structured data into Aleph, an entity mapping file needs to be created. A mapping file uses YAML syntax to describe how information from a table can be projected to FtM entities.
1717

@@ -474,7 +474,7 @@ Mapping files can be loaded in two different ways — either from an aleph shell
474474
aleph bulkload mapping.yml
475475
```
476476

477-
or by using a combination of [`followthemoney-util`](https://docs.alephdata.org/developers/ftm) and [`alephclient`](https://docs.alephdata.org/developers/alephclient) command-line tools:
477+
or by using a combination of [`followthemoney-util`](/developers/followthemoney/ftm) and [`alephclient`](/developers/alephclient) command-line tools:
478478

479479
```
480480
ftm map mapping.yml | ftm aggregate | alephclient write-entities -f dataset_name

helm/charts/aleph/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ Helm chart for Aleph
3737
| global.env.ELASTICSEARCH_TIMEOUT | string | `"600"` | Default elasticsearch timeout |
3838
| global.env.REDIS_URL | string | `"redis://aleph-redis-master.default.svc.cluster.local:6379/0"` | Redis url |
3939

40-
Checkout [https://docs.alephdata.org/developers/installation#configuration](https://docs.alephdata.org/developers/installation#configuration) for all available options.
40+
Checkout [https://docs.aleph.occrp.org/developers/installation#configuration](https://docs.aleph.occrp.org/developers/installation#configuration) for all available options.

mappings/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ md_companies: md_companies.load
1717
# (balkhash) for aggregation. When loaded from the cache, all partial entities
1818
# are combined into one JSON object and ready to be indexed.
1919
#
20-
# See also: https://docs.alephdata.org/developers/mappings
20+
# See also: https://docs.aleph.occrp.org/developers/mappings
2121
%.load:
2222
ftm store delete -d $* -o etl
2323
ftm map $*.yml | ftm store write -o etl -d $*
@@ -29,7 +29,7 @@ md_companies: md_companies.load
2929
# This data is already provided in Follow the Money format and can be loaded into the
3030
# search index straight from a normal curl call.
3131
#
32-
# See also: https://docs.alephdata.org/data-commons/sanctions
32+
# See also: https://docs.aleph.occrp.org/developers/datacommons/#opensanctions
3333
peps: \
3434
everypolitician \
3535
eu_meps \

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
],
1212
author="OCCRP Data Team",
1313
author_email="[email protected]",
14-
url="https://docs.alephdata.org",
14+
url="https://docs.aleph.occrp.org",
1515
license="MIT",
1616
packages=find_packages(exclude=["ez_setup", "examples", "test"]),
1717
namespace_packages=[],

site/aleph.occrp.org/pages/faq.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Please file a request with [OCCRP ID](https://id.occrp.org) to suggest a dataset
2929

3030
Yes! Much of the software we’re building at OCCRP is open source, and we invest a lot of time in making sure other organizations can benefit from this technology as well.
3131

32-
Please visit the [Aleph software documentation](https://docs.alephdata.org/developers/installation) page for information on how to install and operate the software.
32+
Please visit the [Aleph software documentation](/developers/installation) page for information on how to install and operate the software.
3333

3434
### Can I use the Aleph API?
3535

@@ -41,6 +41,6 @@ Using the Aleph API is not a valid approach to “know your customer” (KYC) ch
4141

4242
### How do I get access to bulk data?
4343

44-
We publish a selection of [open datasets](https://docs.alephdata.org/data-commons/sanctions) as part of the Aleph project. We’re also happy to [work with](https://requests.occrp.org/datadesk) other journalists or media organizations to provide bulk exports for specific datasets for your data project.
44+
A number of datasets that are available in OCCRP’s Aleph instance can also be downloaded in the FollowTheMoney format. Please check out the [Data Commons](/developers/datacommons) page for more information. We’re also happy to [work with](https://requests.occrp.org/datadesk) other journalists or media organizations to provide bulk exports for specific datasets for your data project.
4545

4646
It is our policy not to provide bulk exports to non-journalists. This specifically includes banks, due diligence firms, and machine learning researchers.

ui/src/components/Collection/CollectionMappingsMode.jsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ class CollectionMappingsMode extends React.Component {
4040
<p>
4141
<FormattedMessage
4242
id="collection.mappings.create_docs_link"
43-
defaultMessage="For more information, please refer to the {link}"
43+
defaultMessage="For more information, please refer to the {link}."
4444
values={{
4545
link: (
4646
<a
47-
href="https://docs.alephdata.org/guide/building-out-your-investigation/generating-multiple-entities-from-a-list"
47+
href="https://docs.aleph.occrp.org/users/investigations/cross-referencing/#generating-entities-from-yourspreadsheet"
4848
target="_blank"
4949
rel="noopener noreferrer"
5050
>
5151
<FormattedMessage
5252
id="mapping.docs.link"
53-
defaultMessage="Aleph entity mapping documentation"
53+
defaultMessage="Aleph user guide"
5454
/>
5555
</a>
5656
),

ui/src/components/Entity/EntityMappingMode.jsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,17 +120,17 @@ export class EntityMappingMode extends Component {
120120
<p className="text-page-subtitle">
121121
<FormattedMessage
122122
id="mapping.info"
123-
defaultMessage="Follow the steps below to map items in this investigation to structured Follow the Money entites. For more information, please refer to the {link}"
123+
defaultMessage="Follow the steps below to map items in this investigation to structured entites. For more information, please refer to the {link}."
124124
values={{
125125
link: (
126126
<a
127-
href="https://docs.alephdata.org/developers/mappings"
127+
href="https://docs.aleph.occrp.org/users/investigations/cross-referencing/#generating-entities-from-yourspreadsheet"
128128
target="_blank"
129129
rel="noopener noreferrer"
130130
>
131131
<FormattedMessage
132132
id="mapping.info.link"
133-
defaultMessage="Aleph data mapping documentation"
133+
defaultMessage="Aleph user guide"
134134
/>
135135
</a>
136136
),

ui/src/components/Investigation/InvestigationOverview.jsx

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ import { selectCollection, selectNotificationsResult } from 'selectors';
1313

1414
import './InvestigationOverview.scss';
1515

16-
const guidesURLPrefix =
17-
'https://docs.alephdata.org/guide/building-out-your-investigation/';
16+
const guidesURLPrefix = 'https://docs.aleph.occrp.org/users/investigations';
1817

1918
class InvestigationOverview extends React.Component {
2019
render() {
@@ -92,7 +91,7 @@ class InvestigationOverview extends React.Component {
9291
alignText="left"
9392
icon="people"
9493
target="_blank"
95-
href={`${guidesURLPrefix}creating-an-investigation#managing-access-to-your-investigation`}
94+
href={`${guidesURLPrefix}/manage-access/`}
9695
>
9796
<FormattedMessage
9897
id="investigation.overview.guides.access"
@@ -105,7 +104,7 @@ class InvestigationOverview extends React.Component {
105104
alignText="left"
106105
icon="upload"
107106
target="_blank"
108-
href={`${guidesURLPrefix}uploading-documents`}
107+
href={`${guidesURLPrefix}/uploading-documents/`}
109108
>
110109
<FormattedMessage
111110
id="investigation.overview.guides.documents"
@@ -118,7 +117,7 @@ class InvestigationOverview extends React.Component {
118117
alignText="left"
119118
icon="graph"
120119
target="_blank"
121-
href={`${guidesURLPrefix}network-diagrams`}
120+
href={`${guidesURLPrefix}/network-diagrams/`}
122121
>
123122
<FormattedMessage
124123
id="investigation.overview.guides.diagrams"
@@ -131,7 +130,7 @@ class InvestigationOverview extends React.Component {
131130
alignText="left"
132131
icon="new-object"
133132
target="_blank"
134-
href={`${guidesURLPrefix}using-the-table-editor`}
133+
href={`${guidesURLPrefix}/entity-editor/`}
135134
>
136135
<FormattedMessage
137136
id="investigation.overview.guides.entities"
@@ -144,26 +143,13 @@ class InvestigationOverview extends React.Component {
144143
alignText="left"
145144
icon="table"
146145
target="_blank"
147-
href={`${guidesURLPrefix}generating-multiple-entities-from-a-list`}
146+
href={`${guidesURLPrefix}/cross-referencing/`}
148147
>
149148
<FormattedMessage
150149
id="investigation.overview.guides.mappings"
151150
defaultMessage="Generating entities from a spreadsheet"
152151
/>
153152
</AnchorButton>
154-
<AnchorButton
155-
minimal
156-
intent={Intent.PRIMARY}
157-
alignText="left"
158-
icon="comparison"
159-
target="_blank"
160-
href={`${guidesURLPrefix}cross-referencing`}
161-
>
162-
<FormattedMessage
163-
id="investigation.overview.guides.xref"
164-
defaultMessage="Cross-referencing your data"
165-
/>
166-
</AnchorButton>
167153
</div>
168154
</div>
169155
</div>

ui/src/components/common/AppItem.jsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ class AppItem extends PureComponent {
3636
className={Classes.TEXT_DISABLED}
3737
icon="code"
3838
text={message}
39-
href="https://docs.alephdata.org"
39+
href="https://docs.aleph.occrp.org"
4040
/>
4141
<MenuItem
4242
className={Classes.TEXT_DISABLED}
4343
icon="code"
4444
text={ftmMessage}
45-
href="https://docs.alephdata.org/developers/followthemoney"
45+
href="https://followthemoney.tech"
4646
/>
4747
</>
4848
);

0 commit comments

Comments
 (0)