Skip to content

Commit b28f6ef

Browse files
committed
Fix missing links to new docs from site menu
1 parent 44e8e9a commit b28f6ef

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

docs/features/image_name_substitution.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Testcontainers supports automatic substitution of Docker image names.
55
This allows replacement of an image name specified in test code with an alternative name - for example, to replace the
66
name of a Docker Hub image dependency with an alternative hosted on a private image registry.
77

8-
This is advisable to avoid [Docker Hub rate limiting](./pull_rate_limiting.md), and some companies will prefer this for policy reasons.
8+
This is advisable to avoid [Docker Hub rate limiting](../supported_docker_environment/image_registry_rate_limiting.md), and some companies will prefer this for policy reasons.
99

1010
This page describes four approaches for image name substitution:
1111

@@ -14,7 +14,7 @@ This page describes four approaches for image name substitution:
1414
* [Developing a custom function for transforming image names on the fly](#developing-a-custom-function-for-transforming-image-names-on-the-fly)
1515
* [Overriding image names individually in configuration](#overriding-image-names-individually-in-configuration)
1616

17-
It is assumed that you have already set up a private registry hosting [all the Docker images your build requires](./pull_rate_limiting.md#which-images-are-used-by-testcontainers).
17+
It is assumed that you have already set up a private registry hosting [all the Docker images your build requires](../supported_docker_environment/image_registry_rate_limiting.md#which-images-are-used-by-testcontainers).
1818

1919

2020

@@ -25,7 +25,7 @@ Consider this if:
2525

2626
* You use only a few images and updating code is not a chore
2727
* All developers and CI machines in your organisation have access to a common registry server
28-
* You also use one of the automated mechanisms to substitute [the images that Testcontainers itself requires](./pull_rate_limiting.md#which-images-are-used-by-testcontainers)
28+
* You also use one of the automated mechanisms to substitute [the images that Testcontainers itself requires](../supported_docker_environment/image_registry_rate_limiting.md#which-images-are-used-by-testcontainers)
2929

3030
This approach simply entails modifying test code manually, e.g. changing:
3131

docs/features/pull_rate_limiting.md renamed to docs/supported_docker_environment/image_registry_rate_limiting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ As of the current version of Testcontainers ({{latest_version}}):
1111

1212
* every image directly used by your tests
1313
* images pulled by Testcontainers itself to support functionality:
14-
* [`testcontainers/ryuk`](https://hub.docker.com/r/testcontainers/ryuk) - performs fail-safe cleanup of containers, and always required (unless [Ryuk is disabled](./configuration.md#disabling-ryuk))
15-
* [`alpine`](https://hub.docker.com/r/_/alpine) - used to check whether images can be pulled at startup, and always required (unless [startup checks are disabled](./configuration.md#disabling-the-startup-checks))
16-
* [`testcontainers/sshd`](https://hub.docker.com/r/testcontainers/sshd) - required if [exposing host ports to containers](./networking.md#exposing-host-ports-to-the-container)
14+
* [`testcontainers/ryuk`](https://hub.docker.com/r/testcontainers/ryuk) - performs fail-safe cleanup of containers, and always required (unless [Ryuk is disabled](../features/configuration.md#disabling-ryuk))
15+
* [`alpine`](https://hub.docker.com/r/_/alpine) - used to check whether images can be pulled at startup, and always required (unless [startup checks are disabled](../features/configuration.md#disabling-the-startup-checks))
16+
* [`testcontainers/sshd`](https://hub.docker.com/r/testcontainers/sshd) - required if [exposing host ports to containers](../features/networking.md#exposing-host-ports-to-the-container)
1717
* [`testcontainers/vnc-recorder`](https://hub.docker.com/r/testcontainers/vnc-recorder) - required if using [Webdriver containers](../modules/webdriver_containers.md) and using the screen recording feature
1818
* [`docker/compose`](https://hub.docker.com/r/docker/compose) - required if using [Docker Compose](../modules/docker_compose.md)
1919
* [`alpine/socat`](https://hub.docker.com/r/alpine/socat) - required if using [Docker Compose](../modules/docker_compose.md)

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ nav:
3636
- features/container_logs.md
3737
- features/creating_images.md
3838
- features/configuration.md
39+
- features/image_name_substitution.md
3940
- features/advanced_options.md
4041
- Modules:
4142
- Databases:
@@ -86,6 +87,7 @@ nav:
8687
- supported_docker_environment/continuous_integration/bitbucket_pipelines.md
8788
- supported_docker_environment/windows.md
8889
- supported_docker_environment/logging_config.md
90+
- supported_docker_environment/image_registry_rate_limiting.md
8991
- Getting help: getting_help.md
9092
- Contributing:
9193
- contributing.md

0 commit comments

Comments
 (0)