Skip to content

Commit 88633f5

Browse files
authored
docs: Fix broken examples links (#103)
Motivation ---------- Restructuring the documentation has left some broken links. Modifications ------------- * The examples link in the top level README should point to the documentation on Swift Package Index. * The examples link in the top level DoCC page should point to the examples directory on GitHub. Result ------ All links point to the correct pages. Test Plan --------- Tested manually.
1 parent c148c56 commit 88633f5

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904
6565

6666
* Swift Container Plugin runs on macOS and Linux and requires Swift 6.0 or later.
6767
* On macOS you must install a cross-compilation Swift SDK, such as the [Swift Static Linux SDK](https://www.swift.org/documentation/articles/static-linux-getting-started.html), in order to build executables which can run on Linux-based cloud infrastructure.
68-
* A container runtime is not required to build an image, but one must be available wherever the image is to be run.
68+
* A container runtime is not required to build an image, but one must be available wherever the image is to be run.
6969

7070
## Getting Started
7171

72-
Learn more about setting up your project in the [ContainerImageBuilder plugin documentation](Sources/ContainerImageBuilderPluginDocumentation/Documentation.docc/ContainerImageBuilderPlugin.md).
72+
Learn more about setting up your project in the [plugin documentation](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/containerimagebuilderplugin).
7373

7474
Take a look at the [Examples](Examples).

Sources/swift-container-plugin/Documentation.docc/Adding-the-plugin-to-your-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Swift Container Plugin is distributed as a Swift Package Manager package. To
1111
> Adding the same dependency to your project more than once will prevent it from building.
1212
> If this happens, delete the duplicate dependency lines from `Package.swift` and rebuild.
1313
14-
Recent versions of `swift package` suupport the `add-dependency` command:
14+
Recent versions of `swift package` support the `add-dependency` command:
1515

1616
```shell
1717
swift package add-dependency https://github.com/apple/swift-container-plugin --from 0.5.0
@@ -34,4 +34,4 @@ After installation, Swift Package Manager should show that the `ContainerImageBu
3434
```shell
3535
% swift package plugin --list
3636
‘build-container-image’ (plugin ‘ContainerImageBuilder’ in package ‘swift-container-plugin)
37-
```
37+
```

Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904
6565
2024-05-26T22:57:50+0000 info HummingBird : [HummingbirdCore] Server started and listening on 0.0.0.0:8080
6666
```
6767

68-
Take a look at the [Examples](Examples).
68+
Take a look at some [other examples](https://github.com/apple/swift-container-plugin/tree/main/Examples).
6969

7070
## Topics
7171

0 commit comments

Comments
 (0)