Skip to content

Commit

Permalink
Fix site links
Browse files Browse the repository at this point in the history
  • Loading branch information
jaguililla committed Feb 27, 2024
1 parent 35f56e9 commit a990185
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 48 deletions.
10 changes: 2 additions & 8 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,10 @@ The following code block shows the most common use cases for the [Logger] class:

@code core/src/test/kotlin/com/hexagonkt/core/logging/LoggerTest.kt?logger

By default, Hexagon uses the [Java Util Logging] logging library, you can use any of its
implementations by just adding another logging adapter as a dependency. Below you can see some
alternatives:

* [Logback](/logging_logback)
* [SLF4J JUL](/logging_slf4j_jul)
By default, Hexagon uses the [System.Logger] class.

[Logger]: /api/core/com.hexagonkt.core.logging/-logger
[Java Util Logging]:
https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html
[System.Logger]: https://docs.oracle.com/javase/9/docs/api/java/lang/System.Logger.html

# Package com.hexagonkt.core.media
Media types definitions and constants for default media types.
Expand Down
8 changes: 4 additions & 4 deletions http/http_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Check this code snippet to get a glimpse on how to send the most general request

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/ClientTest.kt?genericRequest

[Request]: /api/http_client/com.hexagonkt.http.client.model/-http-client-request
[Response]: /api/http_client/com.hexagonkt.http.client.model/-http-client-response
[Request]: /api/http/http/com.hexagonkt.http.model/-http-request
[Response]: /api/http/http/com.hexagonkt.http.model/-http-response

# Simple requests shortcuts
There are utility methods to make the most common request in an easy way.
Expand Down Expand Up @@ -89,8 +89,8 @@ format.
To set up client/server certificates, you need to include [SslSettings] in your [ClientSettings]. In
the sections below you can see how to configure these parameters.

[SslSettings]: /api/http/com.hexagonkt.http/-ssl-settings
[ClientSettings]: /api/http_client/com.hexagonkt.http.client/-http-client-settings
[SslSettings]: /api/http/http/com.hexagonkt.http/-ssl-settings
[ClientSettings]: /api/http/http_client/com.hexagonkt.http.client/-http-client-settings

## Key Store
This store holds the identity certificate, this certificate is presented to the server by the client
Expand Down
20 changes: 10 additions & 10 deletions http/http_handlers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ methods.

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?serverCreation

[server settings]: /api/http_server/com.hexagonkt.http.server/-http-server-settings
[server settings]: /api/http/http_server/com.hexagonkt.http.server/-http-server-settings
[handlers section]: /http_server/#handlers
[start()]: /api/http_server/com.hexagonkt.http.server/-http-server/start.html
[stop()]: /api/http_server/com.hexagonkt.http.server/-http-server/stop.html
[start()]: /api/http/http_server/com.hexagonkt.http.server/-http-server
[stop()]: /api/http/http_server/com.hexagonkt.http.server/-http-server

## Servlet Web server
There is a special server adapter for running inside Servlet Containers. To use it you should import
Expand All @@ -103,7 +103,7 @@ full list of methods. This sample code illustrates the usage:

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?callbackCall

[API documentation]: /api/http_server/com.hexagonkt.http.server.handlers/-http-server-context
[API documentation]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-context

# Handlers
The main building blocks of Hexagon HTTP services are a set of handlers. A handler is made up of two
Expand Down Expand Up @@ -139,7 +139,7 @@ Check the next snippet for Handlers usage examples:

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?routesCreation

[next]: /api/http_server/com.hexagonkt.http.server.handlers/-http-server-context/next.html
[next]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-context

<!-- TODO Start document review -->

Expand All @@ -157,7 +157,7 @@ the following fields:

It yields true if all the supplied fields matches a call context.

[HttpPredicate]: /api/http_server/com.hexagonkt.http.handlers/-http-predicate
[HttpPredicate]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-predicate

## Path Patterns
Patterns to match requests paths. They can have:
Expand Down Expand Up @@ -302,7 +302,7 @@ different handlers. Check the [CorsCallback][CORS Callbacks] class for more deta

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/CorsTest.kt?cors

[CORS Callbacks]: /api/http_server/com.hexagonkt.http.server.callbacks/-cors-callback
[CORS Callbacks]: /api/http/http_server/com.hexagonkt.http.server.callbacks/-cors-callback

# HTTPS
It is possible to start a secure server enabling HTTPS. For this, you have to provide a server
Expand All @@ -327,14 +327,14 @@ Below you can find a simple example to set up an HTTPS server and client with mu

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/HttpsTest.kt?https

[SslSettings]: /api/http/com.hexagonkt.http/-ssl-settings
[SslSettings]: /api/http/http/com.hexagonkt.http/-ssl-settings
[HTTP/2]: https://en.wikipedia.org/wiki/HTTP/2
[ALPN]: https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation
[Gradle]: https://gradle.org
[create sample certificates]: /gradle/#certificates
[mutual TLS]: https://en.wikipedia.org/wiki/Mutual_authentication
[SslSettings.clientAuth]: /api/http/com.hexagonkt.http/-ssl-settings/client-auth.html
[Request.certificateChain]: /api/http_server/com.hexagonkt.http.server.model/-http-server-request/certificate-chain.html
[SslSettings.clientAuth]: /api/http/http/com.hexagonkt.http/-ssl-settings
[Request.certificateChain]: /api/http/http/com.hexagonkt.http.model/-http-request

# WebSockets
A Web Socket is an HTTP(S) connection made with the GET method and the `upgrade: websocket` and
Expand Down
26 changes: 12 additions & 14 deletions http/http_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ methods.

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?serverCreation

[server settings]: /api/http_server/com.hexagonkt.http.server/-http-server-settings
[server settings]: /api/http/http_server/com.hexagonkt.http.server/-http-server-settings
[handlers section]: /http_server/#handlers
[start()]: /api/http_server/com.hexagonkt.http.server/-http-server/start.html
[stop()]: /api/http_server/com.hexagonkt.http.server/-http-server/stop.html
[start()]: /api/http/http_server/com.hexagonkt.http.server/-http-server
[stop()]: /api/http/http_server/com.hexagonkt.http.server/-http-server

## Servlet Web server
There is a special server adapter for running inside Servlet Containers. To use it you should import
Expand All @@ -98,7 +98,7 @@ full list of methods. This sample code illustrates the usage:

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?callbackCall

[API documentation]: /api/http_server/com.hexagonkt.http.server.handlers/-http-server-context
[API documentation]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-context

# Handlers
The main building blocks of Hexagon HTTP services are a set of handlers. A handler is made up of two
Expand Down Expand Up @@ -134,7 +134,7 @@ Check the next snippet for Handlers usage examples:

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/SamplesTest.kt?routesCreation

[next]: /api/http_server/com.hexagonkt.http.server.handlers/-http-server-context/next.html
[next]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-context

<!-- TODO Start document review -->

Expand All @@ -152,7 +152,7 @@ the following fields:

It yields true if all the supplied fields matches a call context.

[HttpPredicate]: /api/http_server/com.hexagonkt.http.handlers/-http-predicate
[HttpPredicate]: /api/http/http_handlers/com.hexagonkt.http.handlers/-http-predicate

## Path Patterns
Patterns to match requests paths. They can have:
Expand Down Expand Up @@ -297,7 +297,7 @@ different handlers. Check the [CorsCallback][CORS Callbacks] class for more deta

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/CorsTest.kt?cors

[CORS Callbacks]: /api/http_server/com.hexagonkt.http.server.callbacks/-cors-callback
[CORS Callbacks]: /api/http/http_server/com.hexagonkt.http.server.callbacks/-cors-callback

# HTTPS
It is possible to start a secure server enabling HTTPS. For this, you have to provide a server
Expand All @@ -322,14 +322,14 @@ Below you can find a simple example to set up an HTTPS server and client with mu

@code http/http_test/src/main/kotlin/com/hexagonkt/http/test/examples/HttpsTest.kt?https

[SslSettings]: /api/http/com.hexagonkt.http/-ssl-settings
[SslSettings]: /api/http/http/com.hexagonkt.http/-ssl-settings
[HTTP/2]: https://en.wikipedia.org/wiki/HTTP/2
[ALPN]: https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation
[Gradle]: https://gradle.org
[create sample certificates]: /gradle/#certificates
[mutual TLS]: https://en.wikipedia.org/wiki/Mutual_authentication
[SslSettings.clientAuth]: /api/http/com.hexagonkt.http/-ssl-settings/client-auth.html
[Request.certificateChain]: /api/http_server/com.hexagonkt.http.server.model/-http-server-request/certificate-chain.html
[SslSettings.clientAuth]: /api/http/http/com.hexagonkt.http/-ssl-settings
[Request.certificateChain]: /api/http/http/com.hexagonkt.http.model/-http-request

# WebSockets
A Web Socket is an HTTP(S) connection made with the GET method and the `upgrade: websocket` and
Expand Down Expand Up @@ -395,9 +395,7 @@ Contains the HTTP handlers implementation (on top of Core's general event handle
HTTP handlers (AfterHandler, OnHandler, PathHandler and FilterHandler) and the HTTP predicate.

# Package com.hexagonkt.http.server.model
Classes to model server HTTP messages (requests and responses). Built on top of the [http] module.
Classes to model server HTTP messages (requests and responses). Built on top of the `http` module.

# Package com.hexagonkt.http.model.ws
Classes to model server HTTP messages (requests and responses). Built on top of the [http] module.

[http]: /http
Classes to model server HTTP messages (requests and responses). Built on top of the `http` module.
19 changes: 8 additions & 11 deletions site/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,11 @@ Singleton object to manage a cross toolkit aspect. I.e., Serialization or Templa
The libraries inside the `hexagon_extra` repository provide extra features. They may be useful to
develop applications, but not strictly required. Some of these modules are:

* [Schedulers]: Provides repeated tasks execution based on [Cron] expressions.
* [Models]: Contain classes that model common data objects.
* [Args]: Command line arguments definition and parsing.
* Schedulers: Provides repeated tasks execution based on [Cron] expressions.
* Models: Contain classes that model common data objects.
* Args: Command line arguments definition and parsing.

[Web]: /web
[Schedulers]: /scheduler
[Models]: /models
[Args]: /args
[Cron]: https://en.wikipedia.org/wiki/Cron

# Architecture
Expand Down Expand Up @@ -163,11 +160,11 @@ Ports with their provided implementations (Adapters).
[Rocker]: /templates_rocker
[jte]: /templates_jte
[Serialization Formats]: /core/#serialization
[JSON]: /api/serialization_jackson_json/com.hexagonkt.serialization.jackson.json/-json
[YAML]: /api/serialization_jackson_yaml/com.hexagonkt.serialization.jackson.yaml/-yaml
[CSV]: /api/serialization_jackson_csv/com.hexagonkt.serialization.jackson.csv/-csv
[XML]: /api/serialization_jackson_xml/com.hexagonkt.serialization.jackson.xml/-xml
[TOML]: /api/serialization_jackson_toml/com.hexagonkt.serialization.jackson.toml/-toml
[JSON]: /api/serialization/serialization_jackson_json/com.hexagonkt.serialization.jackson.json/-json
[YAML]: /api/serialization/serialization_jackson_yaml/com.hexagonkt.serialization.jackson.yaml/-yaml
[CSV]: /api/serialization/serialization_jackson_csv/com.hexagonkt.serialization.jackson.csv/-csv
[XML]: /api/serialization/serialization_jackson_xml/com.hexagonkt.serialization.jackson.xml/-xml
[TOML]: /api/serialization/serialization_jackson_toml/com.hexagonkt.serialization.jackson.toml/-toml

# Module Dependencies
Module dependencies (including extra modules):
Expand Down
2 changes: 1 addition & 1 deletion templates/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ and `_now_` variables) are added to the context automatically. Check the code be

@code templates/templates/src/test/kotlin/com/hexagonkt/templates/examples/TemplatesTest.kt?templateUsage

[TemplateManager]: /api/templates/com.hexagonkt.templates/-template-manager/index.html
[TemplateManager]: /api/templates/templates/com.hexagonkt.templates/-template-manager

# Package com.hexagonkt.templates
Feature implementation code.

0 comments on commit a990185

Please sign in to comment.