Skip to content

docs: Fix broken examples links #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2025
Merged

docs: Fix broken examples links #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904

* Swift Container Plugin runs on macOS and Linux and requires Swift 6.0 or later.
* 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.
* A container runtime is not required to build an image, but one must be available wherever the image is to be run.
* A container runtime is not required to build an image, but one must be available wherever the image is to be run.

## Getting Started

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

Take a look at the [Examples](Examples).
4 changes: 2 additions & 2 deletions .../swift-container-plugin/Documentation.docc/Adding-the-plugin-to-your-project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Swift Container Plugin is distributed as a Swift Package Manager package. To
> Adding the same dependency to your project more than once will prevent it from building.
> If this happens, delete the duplicate dependency lines from `Package.swift` and rebuild.

Recent versions of `swift package` suupport the `add-dependency` command:
Recent versions of `swift package` support the `add-dependency` command:

```shell
swift package add-dependency https://github.com/apple/swift-container-plugin --from 0.5.0
Expand All @@ -34,4 +34,4 @@ After installation, Swift Package Manager should show that the `ContainerImageBu
```shell
% swift package plugin --list
‘build-container-image’ (plugin ‘ContainerImageBuilder’ in package ‘swift-container-plugin)
```
```
2 changes: 1 addition & 1 deletion Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904
2024-05-26T22:57:50+0000 info HummingBird : [HummingbirdCore] Server started and listening on 0.0.0.0:8080
```

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

## Topics

Expand Down