Skip to content

Commit 1560837

Browse files
committed
fix(docs): many broken links
Signed-off-by: Fatih Acar <[email protected]>
1 parent 6cbea3a commit 1560837

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

docs/_templates/infrahub_config.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Infrahub containers have a number of environmental variables available at ru
1313
Here are a few common methods of setting environmental variables:
1414

1515
- Exporting in a shell, example: `export INFRAHUB_ADDRESS="http://localhost:8000"`
16-
- Using a [`.env` file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file)
16+
- Using a [`.env` file](https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/#env-file)
1717
- Using [direnv](https://direnv.net/)
1818

1919
:::note

docs/docs/development/docs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Here are questions to ask when deciding where to place a new document:
253253
- Are you providing background information, explanation, or abstract concepts? Select **Topics**.
254254
- Are you providing APIs, command references, or concise reference information? Select **Reference**.
255255

256-
If you're unsure where something goes, diátaxis offers a [map](https://diataxis.fr/needs/) and [compass](https://diataxis.fr/compass/) to help.
256+
If you're unsure where something goes, diátaxis offers a [map](https://diataxis.fr/map/) and [compass](https://diataxis.fr/compass/) to help.
257257

258258
When creating a new page in the documentation, in addition to creating the `.mdx` file containing the documentation itself, you must also add the page to the relevant section of the `sidebars.ts` file.
259259

docs/docs/reference/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Infrahub containers have a number of environmental variables available at ru
1313
Here are a few common methods of setting environmental variables:
1414

1515
- Exporting in a shell, example: `export INFRAHUB_ADDRESS="http://localhost:8000"`
16-
- Using a [`.env` file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file)
16+
- Using a [`.env` file](https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/#env-file)
1717
- Using [direnv](https://direnv.net/)
1818

1919
:::note

docs/docs/reference/schema-validation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ schemas:
6060
6161
:::note
6262
63-
The schema of the Infrahub external repository configuration file has been published on [JSON Schema store](https://www.schemastore.org/json/). It allows an editor, like Visual Studio Code to download the correct schema validation file. Visual Studio Code will automatically validate a file named `.infrahub.y(a)ml` with this schema, if the Red Hat YAML Language server is installed.
63+
The schema of the Infrahub external repository configuration file has been published on [JSON Schema store](https://www.schemastore.org/). It allows an editor, like Visual Studio Code to download the correct schema validation file. Visual Studio Code will automatically validate a file named `.infrahub.y(a)ml` with this schema, if the Red Hat YAML Language server is installed.
6464

6565
:::

docs/docs/release-notes/infrahub/release-1_2_1.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ If you current schema is not valid anymore with Infrahub 1.2 our recommendation
4747

4848
In 1.2, we introduced a new command to upgrade Infrahub `infrahub upgrade`, unfortunately due to a bug the command was missing in Infrahub Enterprise.
4949

50-
The issue has been fixed in 1.2.1 and the documentation has been updated to include more information regarding the upgrade procedure for Infrahub [Community](https://docs.infrahub.app/guides/upgrade) & [Enterprise](https://docs.infrahub.app/guides/upgrade-enterprise)
50+
The issue has been fixed in 1.2.1 and the documentation has been updated to include more information regarding the upgrade procedure for Infrahub [Community](https://docs.infrahub.app/guides/upgrade) & [Enterprise](https://docs.infrahub.app/guides/upgrade#enterprise)
5151

5252
## Main changes
5353

docs/docs/topics/database-backup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The first option is probably easier. The second option can be achieved by ensuri
9494

9595
You must specify the directory containing the backup files you wish to restore on the Infrahub database in the `backup_directory` argument to the `db_backup neo4j restore` command. This directory should contain `.backup` files produced by the `db_backup neo4j backup` command. The files must be of the format `<database_name>-2024-02-07T22-12-16.backup`. Given the default database configuration, a backup will produce two `.backup` files: one for the `neo4j` database and one for the `system` database.
9696

97-
The `backup` utility produces a `.backup` file for the `system` database, but the `restore` utility will not attempt to restore a `system` database backup. This should not cause any problems for you unless your Infrahub database has suffered a catastrophic failure. Neo4j provides documentation on this process [here](https://neo4j.com/docs/operations-manual/current/clustering/disaster-recovery/#_restore_the_system_database), but it is beyond the scope of what this utility is intended to do.
97+
The `backup` utility produces a `.backup` file for the `system` database, but the `restore` utility will not attempt to restore a `system` database backup. This should not cause any problems for you unless your Infrahub database has suffered a catastrophic failure. Neo4j provides documentation on this process [here](https://neo4j.com/docs/operations-manual/5/clustering/disaster-recovery/#make-the-system-database-write-available), but it is beyond the scope of what this utility is intended to do.
9898

9999
### Downtime
100100

0 commit comments

Comments
 (0)