Skip to content

Rework SSL/TLS documentation.#5981

Merged
vietj merged 1 commit intomasterfrom
tcp-ssl-documentation
Feb 18, 2026
Merged

Rework SSL/TLS documentation.#5981
vietj merged 1 commit intomasterfrom
tcp-ssl-documentation

Conversation

@vietj
Copy link
Member

@vietj vietj commented Feb 18, 2026

Motivation:

The current SSL/TLS documentation is coupled to the Vert.x Net documentation.

Most of the SSL/TLS configuration has been encapsulated in SSLOptions/ClientSSLOptions/ServerSSLOptions.

We should provide a base documentation for configuring those options and keep the Vert.x Net configuration to a minimum and refer to the documentation of those options.

Changes:

Extracted the Vert.x Net client/server SSL configuration part that is generic and not coupled to this section of the documentation in a new top level section that generically documents client/server SSL options.

Keep in Vert.x Net documentation the specific documentation.

Added examples for ConnectOptions SSL configuration.

Move the TLS upgrade documentation to the Net SSL documentation section.

Motivation:

The current SSL/TLS documentation is coupled to the Vert.x Net documentation.

Most of the SSL/TLS configuration has been encapsulated in SSLOptions/ClientSSLOptions/ServerSSLOptions.

We should provide a base documentation for configuring those options and keep the Vert.x Net configuration to a minimum and refer to the documentation of those options.

Changes:

Extracted the Vert.x Net client/server SSL configuration part that is generic and not coupled to this section of the documentation in a new top level section that generically documents client/server SSL options.

Keep in Vert.x Net documentation the specific documentation.

Added examples for ConnectOptions SSL configuration.

Move the TLS upgrade documentation to the Net SSL documentation section.
@vietj vietj added this to the 5.1.0 milestone Feb 18, 2026
@vietj vietj merged commit 7aafd05 into master Feb 18, 2026
7 checks passed
@vietj vietj deleted the tcp-ssl-documentation branch February 18, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments