Skip to content

Commit 4172787

Browse files
authored
Point docs to Swift Package Index (#2353)
Motivation: The NIO docs are now published on the Swift Package Index but the README still refers to GitHub pages. Modifications: - Update README and other docs to point to Swift Package Index. Result: Documentation links work
1 parent 1a0f46b commit 4172787

File tree

2 files changed

+28
-20
lines changed

2 files changed

+28
-20
lines changed

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Low-level protocol implementations are often a collection of [`ChannelHandler`][
4545

4646
Protocol | Client | Server | Repository | Module | Comment
4747
--- | --- | --- | --- | --- | ---
48-
HTTP/1 | ✅| ✅ | [apple/swift-nio](https://github.com/apple/swift-nio) | [`NIOHTTP1`](https://apple.github.io/swift-nio/docs/current/NIOHTTP1/index.html) | official NIO project
49-
HTTP/2 | ✅| ✅ | [apple/swift-nio-http2](https://github.com/apple/swift-nio-http2) | [`NIOHTTP2`](https://apple.github.io/swift-nio-http2/docs/current/NIOHTTP2/index.html) | official NIO project
50-
WebSocket | ✅| ✅ | [apple/swift-nio](https://github.com/apple/swift-nio) | [`NIOWebSocket`](https://apple.github.io/swift-nio/docs/current/NIOWebSocket/index.html) | official NIO project
51-
TLS | ✅ | ✅ | [apple/swift-nio-ssl](https://github.com/apple/swift-nio-ssl) | [`NIOSSL`](https://apple.github.io/swift-nio-ssl/docs/current/NIOSSL/index.html) | official NIO project
52-
SSH | ✅ | ✅ | [apple/swift-nio-ssh][repo-nio-ssh] | _n/a_ | official NIO project
48+
HTTP/1 | ✅| ✅ | [apple/swift-nio](https://github.com/apple/swift-nio) | [`NIOHTTP1`][nioh1] | official NIO project
49+
HTTP/2 | ✅| ✅ | [apple/swift-nio-http2](https://github.com/apple/swift-nio-http2) | [`NIOHTTP2`][nioh2] | official NIO project
50+
WebSocket | ✅| ✅ | [apple/swift-nio](https://github.com/apple/swift-nio) | [`NIOWebSocket`][niows] | official NIO project
51+
TLS | ✅ | ✅ | [apple/swift-nio-ssl](https://github.com/apple/swift-nio-ssl) | [`NIOSSL`][niossl] | official NIO project
52+
SSH | ✅ | ✅ | [apple/swift-nio-ssh][repo-nio-ssh] | [`NIOSSH`][niossh] | official NIO project
5353

5454

5555
#### High-level implementations
@@ -174,7 +174,7 @@ While it is possible to configure and register [`Channel`][c]s with [`EventLoop`
174174

175175
For this reason, SwiftNIO ships a number of `Bootstrap` objects whose purpose is to streamline the creation of channels. Some `Bootstrap` objects also provide other functionality, such as support for Happy Eyeballs for making TCP connection attempts.
176176

177-
Currently SwiftNIO ships with three `Bootstrap` objects in the `NIOPosix` module: [`ServerBootstrap`](https://apple.github.io/swift-nio/docs/current/NIOPosix/Classes/ServerBootstrap.html), for bootstrapping listening channels; [`ClientBootstrap`](https://apple.github.io/swift-nio/docs/current/NIOPosix/Classes/ClientBootstrap.html), for bootstrapping client TCP channels; and [`DatagramBootstrap`](https://apple.github.io/swift-nio/docs/current/NIOPosix/Classes/DatagramBootstrap.html) for bootstrapping UDP channels.
177+
Currently SwiftNIO ships with three `Bootstrap` objects in the `NIOPosix` module: [`ServerBootstrap`][sbootstrap], for bootstrapping listening channels; [`ClientBootstrap`][cbootstrap], for bootstrapping client TCP channels; and [`DatagramBootstrap`][dbootstrap] for bootstrapping UDP channels.
178178

179179
#### ByteBuffer
180180

@@ -210,7 +210,7 @@ The core SwiftNIO repository will contain a few extremely important protocol imp
210210

211211
## Documentation
212212

213-
- [API documentation](https://apple.github.io/swift-nio/docs/current/NIOCore/index.html)
213+
- [API documentation](https://swiftpackageindex.com/apple/swift-nio/main/documentation/nio)
214214

215215
## Example Usage
216216

@@ -350,18 +350,26 @@ apt-get install -y git curl libatomic1 libxml2 netcat-openbsd lsof perl
350350
dnf install swift-lang /usr/bin/nc /usr/bin/lsof /usr/bin/shasum
351351
```
352352

353-
[ch]: https://apple.github.io/swift-nio/docs/current/NIOCore/Protocols/ChannelHandler.html
354-
[c]: https://apple.github.io/swift-nio/docs/current/NIOCore/Protocols/Channel.html
355-
[chc]: https://apple.github.io/swift-nio/docs/current/NIOCore/Classes/ChannelHandlerContext.html
356-
[ec]: https://apple.github.io/swift-nio/docs/current/NIOCore/Classes/EmbeddedChannel.html
357-
[el]: https://apple.github.io/swift-nio/docs/current/NIOCore/Protocols/EventLoop.html
358-
[eel]: https://apple.github.io/swift-nio/docs/current/NIOCore/Classes/EmbeddedEventLoop.html
359-
[elg]: https://apple.github.io/swift-nio/docs/current/NIOCore/Protocols/EventLoopGroup.html
360-
[bb]: https://apple.github.io/swift-nio/docs/current/NIOCore/Structs/ByteBuffer.html
361-
[elf]: https://apple.github.io/swift-nio/docs/current/NIOCore/Classes/EventLoopFuture.html
362-
[elp]: https://apple.github.io/swift-nio/docs/current/NIOCore/Structs/EventLoopPromise.html
363-
[cp]: https://apple.github.io/swift-nio/docs/current/NIOCore/Classes/ChannelPipeline.html
364-
[mtelg]: https://apple.github.io/swift-nio/docs/current/NIOPosix/Classes/MultiThreadedEventLoopGroup.html
353+
[ch]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelhandler
354+
[c]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channel
355+
[chc]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelhandlercontext
356+
[ec]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioembedded/embeddedchannel
357+
[el]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloop
358+
[eel]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioembedded/embeddedeventloop
359+
[elg]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloopgroup
360+
[bb]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/bytebuffer
361+
[elf]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloopfuture
362+
[elp]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventlooppromise
363+
[cp]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelpipeline
364+
[sbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/serverbootstrap
365+
[cbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/clientbootstrap
366+
[dbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/datagrambootstrap
367+
[mtelg]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/multithreadedeventloopgroup
368+
[nioh1]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niohttp1
369+
[nioh2]: https://swiftpackageindex.com/apple/swift-nio-http2/main/documentation/niohttp2
370+
[niows]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niowebsocket
371+
[niossl]: https://swiftpackageindex.com/apple/swift-nio-ssl/main/documentation/niossl
372+
[niossh]: https://swiftpackageindex.com/apple/swift-nio-ssh/main/documentation/niossh
365373
[pthreads]: https://en.wikipedia.org/wiki/POSIX_Threads
366374
[kqueue]: https://en.wikipedia.org/wiki/Kqueue
367375
[epoll]: https://en.wikipedia.org/wiki/Epoll

docs/public-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SwiftNIO 2 Public API
22

3-
The SwiftNIO project (which includes all of `github.com/apple/swift-nio*`) aims to follow [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) which requires projects to declare a public API. This document along with the [API documentation](https://apple.github.io/swift-nio/) declare SwiftNIO's API.
3+
The SwiftNIO project (which includes all of `github.com/apple/swift-nio*`) aims to follow [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) which requires projects to declare a public API. This document along with the [API documentation](https://swiftpackageindex.com/apple/swift-nio/main/documentation) declare SwiftNIO's API.
44

55
## What are acceptable uses of NIO's Public API
66

0 commit comments

Comments
 (0)