Improve the selection of documentation versions.

Versions of the documentation are now mapped on languages for Hugo,
allowing to leverage the multilingual features of Hugo. The current
stable version is a level above the other versions, improving the
search engine ranking of this version. Version "stable" has the URL
path "/hono/docs/", nightly master has "/hono/docs/dev/" and e.g.
version 1.2.3 would be under "/hono/docs/1.2/". Having a version marked
as stable is required for this to work.
The version is now selected in the documentation itself and no longer
on the homepage.

Signed-off-by: Abel Buechner-Mihaljevic <[email protected]>

Author: b-abel

adapters/http-vertx-base/src/main/java/org/eclipse/hono/adapter/http/AbstractVertxBasedHttpProtocolAdapter.java

@@ -514,7 +514,7 @@ public final void uploadTelemetryMessage(final RoutingContext ctx, final String
      * <p>
      * This method always sends a response to the device. The status code will be set
      * as specified in the
-     * <a href="https://www.eclipse.org/hono/docs/latest/user-guide/http-adapter/#publish-telemetry-data-authenticated-device">
+     * <a href="https://www.eclipse.org/hono/docs/user-guide/http-adapter/#publish-telemetry-data-authenticated-device">
      * HTTP adapter User Guide</a>.
      *
      * @param ctx The context to retrieve cookies and the HTTP response from.
@@ -563,7 +563,7 @@ public final void uploadEventMessage(final RoutingContext ctx, final String tena
      * <p>
      * This method always sends a response to the device. The status code will be set
      * as specified in the
-     * <a href="https://www.eclipse.org/hono/docs/latest/user-guide/http-adapter/#publish-an-event-authenticated-device">
+     * <a href="https://www.eclipse.org/hono/docs/user-guide/http-adapter/#publish-an-event-authenticated-device">
      * HTTP adapter User Guide</a>.
      *
      * @param ctx The context to retrieve cookies and the HTTP response from.

adapters/http-vertx/readme.md

@@ -1,5 +1,5 @@
 This module contains a protocol adapter that exposes a HTTP based API for Hono's Telemetry and Registration API.
 
-Please refer to the [Admin Guide](https://www.eclipse.org/hono/docs/latest/admin-guide/http-adapter-config/) 
+Please refer to the [Admin Guide](https://www.eclipse.org/hono/docs/admin-guide/http-adapter-config/) 
 for details regarding configuration and to the 
-[UserGuide](https://www.eclipse.org/hono/docs/latest/user-guide/http-adapter/) for the usage.
+[UserGuide](https://www.eclipse.org/hono/docs/user-guide/http-adapter/) for the usage.

adapters/http-vertx/src/main/java/org/eclipse/hono/adapter/http/impl/VertxBasedHttpProtocolAdapter.java

@@ -48,7 +48,7 @@
 
 /**
  * A Vert.x based Hono protocol adapter for accessing Hono's Telemetry & Event API using HTTP
- * as described in https://www.eclipse.org/hono/docs/latest/user-guide/http-adapter.
+ * as described in https://www.eclipse.org/hono/docs/user-guide/http-adapter.
  */
 public final class VertxBasedHttpProtocolAdapter extends AbstractVertxBasedHttpProtocolAdapter<HttpProtocolAdapterProperties> {
 

adapters/mqtt-vertx-base/src/main/java/org/eclipse/hono/adapter/mqtt/AbstractVertxBasedMqttProtocolAdapter.java

@@ -523,7 +523,7 @@ private Future<DeviceUser> authenticate(final MqttContext connectContext, final
      * <p>
      * This method currently only supports topic filters for subscribing to
      * commands as defined by Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/user-guide/mqtt-adapter/#command-control">
+     * <a href="https://www.eclipse.org/hono/docs/user-guide/mqtt-adapter/#command-control">
      * MQTT adapter user guide</a>.
      * <p>
      * When a device subscribes to a command topic filter, this method opens a
@@ -665,7 +665,7 @@ private Span newSpan(final String operationName, final MqttEndpoint endpoint, fi
      * <p>
      * This method currently only supports topic filters for unsubscribing from
      * commands as defined by Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/user-guide/mqtt-adapter/#command-control">
+     * <a href="https://www.eclipse.org/hono/docs/user-guide/mqtt-adapter/#command-control">
      * MQTT adapter user guide</a>.
      *
      * @param endpoint The endpoint representing the connection to the device.

adapters/mqtt-vertx/readme.md

@@ -1,5 +1,5 @@
 This module contains a protocol adapter that exposes an MQTT API for Hono's Telemetry API.
 
-Please refer to the [Admin Guide](https://www.eclipse.org/hono/docs/latest/admin-guide/mqtt-adapter-config/) 
+Please refer to the [Admin Guide](https://www.eclipse.org/hono/docs/admin-guide/mqtt-adapter-config/) 
 for details regarding configuration and to the 
-[UserGuide](https://www.eclipse.org/hono/docs/latest/user-guide/mqtt-adapter/) for the usage.
+[UserGuide](https://www.eclipse.org/hono/docs/user-guide/mqtt-adapter/) for the usage.

client/src/main/java/org/eclipse/hono/client/CommandClient.java

@@ -45,7 +45,7 @@ public interface CommandClient extends RequestResponseClient {
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
      *         the (error) status code. Status codes are defined at
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/command-and-control-api">Command and Control API</a>.
+     *         <a href="https://www.eclipse.org/hono/docs/api/command-and-control-api">Command and Control API</a>.
      * @throws NullPointerException if any of device ID or command are {@code null}.
      * @see RequestResponseClient#setRequestTimeout(long)
      */
@@ -68,7 +68,7 @@ public interface CommandClient extends RequestResponseClient {
      *         The future will succeed if a response with status 2xx has been received from the device. If the response has no payload, the future will complete with {@code null}.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
-     *         the (error) status code. Status codes are defined at <a href="https://www.eclipse.org/hono/docs/latest/api/command-and-control-api">Command and Control API</a>.
+     *         the (error) status code. Status codes are defined at <a href="https://www.eclipse.org/hono/docs/api/command-and-control-api">Command and Control API</a>.
      * @throws NullPointerException if any of device ID or command are {@code null}.
      * @see RequestResponseClient#setRequestTimeout(long)
      */

client/src/main/java/org/eclipse/hono/client/CredentialsClient.java

@@ -25,7 +25,7 @@
  * An instance of this interface is always scoped to a specific tenant.
  * </p>
  * <p>
- * See Hono's <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/">
+ * See Hono's <a href="https://www.eclipse.org/hono/docs/api/credentials-api/">
  * Credentials API specification</a> for a description of the result codes returned.
  * </p>
  */
@@ -40,7 +40,7 @@ public interface CredentialsClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         credentials service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/#get-credentials">
+     *         <a href="https://www.eclipse.org/hono/docs/api/credentials-api/#get-credentials">
      *         Get Credentials</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -60,7 +60,7 @@ public interface CredentialsClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         credentials service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/#get-credentials">
+     *         <a href="https://www.eclipse.org/hono/docs/api/credentials-api/#get-credentials">
      *         Get Credentials</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -85,7 +85,7 @@ public interface CredentialsClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         credentials service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/#get-credentials">
+     *         <a href="https://www.eclipse.org/hono/docs/api/credentials-api/#get-credentials">
      *         Get Credentials</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing

client/src/main/java/org/eclipse/hono/client/DeviceConnectionClient.java

@@ -22,7 +22,7 @@
  * <p>
  * An instance of this interface is always scoped to a specific tenant.
  * <p>
- * See Hono's <a href="https://www.eclipse.org/hono/docs/latest/api/device-connection-api/">
+ * See Hono's <a href="https://www.eclipse.org/hono/docs/api/device-connection-api/">
  * Device Connection API specification</a> for a description of the result codes returned.
  */
 public interface DeviceConnectionClient extends RequestResponseClient {

client/src/main/java/org/eclipse/hono/client/RegistrationClient.java

@@ -22,7 +22,7 @@
  * <p>
  * An instance of this interface is always scoped to a specific tenant.
  * <p>
- * See Hono's <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/">
+ * See Hono's <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/">
  * Registration API specification</a> for a description of the result codes returned.
  */
 public interface RegistrationClient extends RequestResponseClient {
@@ -35,7 +35,7 @@ public interface RegistrationClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         registration service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/#assert-device-registration">
+     *         <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/#assert-device-registration">
      *         Assert Device Registration</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -58,7 +58,7 @@ public interface RegistrationClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         registration service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/#assert-device-registration">
+     *         <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/#assert-device-registration">
      *         Assert Device Registration</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -86,7 +86,7 @@ public interface RegistrationClient extends RequestResponseClient {
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         registration service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/#assert-device-registration">
+     *         <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/#assert-device-registration">
      *         Assert Device Registration</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -110,7 +110,7 @@ default Future<JsonObject> assertRegistration(
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the
      *         registration service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/#get-registration-information">
+     *         <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/#get-registration-information">
      *         Get Registration Information</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing
@@ -133,7 +133,7 @@ default Future<JsonObject> assertRegistration(
      *         <p>
      *         The future will succeed if a response with status 200 has been received from the registration service.
      *         The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/device-registration-api/#get-registration-information"> Get
+     *         <a href="https://www.eclipse.org/hono/docs/api/device-registration-api/#get-registration-information"> Get
      *         Registration Information</a>.
      *         <p>
      *         Otherwise, the future will fail with a {@link ServiceInvocationException} containing the (error) status

client/src/main/java/org/eclipse/hono/client/TenantClient.java

@@ -23,7 +23,7 @@
 /**
  * A client for accessing Hono's Tenant API.
  * <p>
- * See Hono's <a href="https://www.eclipse.org/hono/docs/latest/api/tenant-api">
+ * See Hono's <a href="https://www.eclipse.org/hono/docs/api/tenant-api">
  * Tenant API specification</a> for a description of the result codes returned.
  * </p>
  */
@@ -37,7 +37,7 @@ public interface TenantClient extends RequestResponseClient {
      *         <ul>
      *         <li>The future will succeed if a response with status 200 has been received from the
      *         tenant service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/tenant-api/#get-tenant-information">
+     *         <a href="https://www.eclipse.org/hono/docs/api/tenant-api/#get-tenant-information">
      *         Get Tenant Information</a>.</li>
      *         <li>Otherwise, the future will fail with a {@link ServiceInvocationException} containing
      *         the (error) status code returned by the service.</li>
@@ -60,7 +60,7 @@ public interface TenantClient extends RequestResponseClient {
      *         <ul>
      *         <li>The future will succeed if a response with status 200 has been received from the
      *         tenant service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/tenant-api/#get-tenant-information">
+     *         <a href="https://www.eclipse.org/hono/docs/api/tenant-api/#get-tenant-information">
      *         Get Tenant Information</a>.</li>
      *         <li>Otherwise, the future will fail with a {@link ServiceInvocationException} containing
      *         the (error) status code returned by the service.</li>
@@ -85,7 +85,7 @@ default Future<TenantObject> get(final String tenantId, final SpanContext contex
      *         <ul>
      *         <li>The future will succeed if a response with status 200 has been received from the
      *         tenant service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/tenant-api/#get-tenant-information">
+     *         <a href="https://www.eclipse.org/hono/docs/api/tenant-api/#get-tenant-information">
      *         Get Tenant Information</a>.</li>
      *         <li>Otherwise, the future will fail with a {@link ServiceInvocationException} containing
      *         the (error) status code returned by the service.</li>
@@ -114,7 +114,7 @@ default Future<TenantObject> get(final String tenantId, final SpanContext contex
      *         <ul>
      *         <li>The future will succeed if a response with status 200 has been received from the
      *         tenant service. The JSON object will then contain values as defined in
-     *         <a href="https://www.eclipse.org/hono/docs/latest/api/tenant-api/#get-tenant-information">
+     *         <a href="https://www.eclipse.org/hono/docs/api/tenant-api/#get-tenant-information">
      *         Get Tenant Information</a>.</li>
      *         <li>Otherwise, the future will fail with a {@link ServiceInvocationException} containing
      *         the (error) status code returned by the service.</li>

client/src/main/java/org/eclipse/hono/client/impl/CredentialsClientImpl.java

@@ -166,7 +166,7 @@ public static final Future<CredentialsClient> create(
 
     /**
      * Invokes the <em>Get Credentials</em> operation of Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/">Credentials API</a>
+     * <a href="https://www.eclipse.org/hono/docs/api/credentials-api/">Credentials API</a>
      * on the service represented by the <em>sender</em> and <em>receiver</em> links.
      */
     @Override
@@ -176,7 +176,7 @@ public Future<CredentialsObject> get(final String type, final String authId) {
 
     /**
      * Invokes the <em>Get Credentials</em> operation of Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/">Credentials API</a>
+     * <a href="https://www.eclipse.org/hono/docs/api/credentials-api/">Credentials API</a>
      * on the service represented by the <em>sender</em> and <em>receiver</em> links.
      */
     @Override
@@ -186,7 +186,7 @@ public Future<CredentialsObject> get(final String type, final String authId, fin
 
     /**
      * Invokes the <em>Get Credentials</em> operation of Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/api/credentials-api/">Credentials API</a>
+     * <a href="https://www.eclipse.org/hono/docs/api/credentials-api/">Credentials API</a>
      * on the service represented by the <em>sender</em> and <em>receiver</em> links.
      */
     @Override

client/src/main/java/org/eclipse/hono/client/impl/DeviceConnectionClientImpl.java

@@ -159,7 +159,7 @@ private Map<String, Object> createDeviceIdProperties(final String deviceId) {
 
     /**
      * Invokes the <em>Set Last Known Gateway for Device</em> operation of Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/api/device-connection-api">Device Connection API</a>
+     * <a href="https://www.eclipse.org/hono/docs/api/device-connection-api">Device Connection API</a>
      * on the service represented by the <em>sender</em> and <em>receiver</em> links.
      */
     @Override
@@ -192,7 +192,7 @@ public Future<Void> setLastKnownGatewayForDevice(final String deviceId, final St
 
     /**
      * Invokes the <em>Get Last Known Gateway for Device</em> operation of Hono's
-     * <a href="https://www.eclipse.org/hono/docs/latest/api/device-connection-api">Device Connection API</a>
+     * <a href="https://www.eclipse.org/hono/docs/api/device-connection-api">Device Connection API</a>
      * on the service represented by the <em>sender</em> and <em>receiver</em> links.
      */
     @Override