From f91140887064099941606f1aade405c15d8025c4 Mon Sep 17 00:00:00 2001 From: Martin Grigorov Date: Thu, 22 Aug 2024 12:14:48 +0300 Subject: [PATCH] [NO-JIRA] Docs build fixes (#3108) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Remove the usage of a deprecated setting `algolia_docsearch` ``` WARN Config 'params.algolia_docsearch' is deprecated: use 'params.search.algolia' For details, see https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch. ``` Signed-off-by: Martin Tzvetanov Grigorov * Set Go version to 1.22 Fixes the following error: ``` ❯ go mod download go: errors parsing go.mod: /home/martin/git/apache/avro/doc/go.mod:20: invalid go version '1.22.6': must match format 1.23 ``` Signed-off-by: Martin Tzvetanov Grigorov * Fix page references in docs Fixes the following errors: ``` ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:225:37": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:226:31": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:227:41": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:228:51": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:229:63": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:230:31": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/++version++/IDL Language/_index.md:264:212": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:225:37": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:226:31": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:227:41": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:228:51": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:229:63": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:230:31": page reference "specification" is ambiguous ERROR [en] REF_NOT_FOUND: Ref "specification": "/home/runner/work/avro/avro/doc/content/en/docs/1.12.0/IDL Language/_index.md:264:212": page reference "specification" is ambiguous ``` Signed-off-by: Martin Tzvetanov Grigorov --------- Signed-off-by: Martin Tzvetanov Grigorov --- doc/config.toml | 3 --- .../en/docs/++version++/IDL Language/_index.md | 14 +++++++------- doc/content/en/docs/1.12.0/IDL Language/_index.md | 14 +++++++------- doc/go.mod | 2 +- 4 files changed, 15 insertions(+), 18 deletions(-) diff --git a/doc/config.toml b/doc/config.toml index 2fcf46d71d6..8f5c40db097 100644 --- a/doc/config.toml +++ b/doc/config.toml @@ -155,9 +155,6 @@ github_project_repo = "https://github.com/apache/avro" # Google Custom Search Engine ID. Remove or comment out to disable search. # gcs_engine_id = "d72aa9b2712488cc3" -# Enable Algolia DocSearch -algolia_docsearch = false - # Enable Lunr.js offline search offlineSearch = false diff --git a/doc/content/en/docs/++version++/IDL Language/_index.md b/doc/content/en/docs/++version++/IDL Language/_index.md index 7d0121274a9..68c5605b7b3 100644 --- a/doc/content/en/docs/++version++/IDL Language/_index.md +++ b/doc/content/en/docs/++version++/IDL Language/_index.md @@ -222,12 +222,12 @@ The primitive types supported by Avro IDL are the same as those supported by Avr ### Logical Types Some of the logical types supported by Avro's JSON format are directly supported by Avro IDL. The currently supported types are: -* _decimal_ (logical type [decimal]({{< relref "specification#decimal" >}})) -* _date_ (logical type [date]({{< relref "specification#date" >}})) -* _time_ms_ (logical type [time-millis]({{< relref "specification#time-millisecond-precision" >}})) -* _timestamp_ms_ (logical type [timestamp-millis]({{< relref "specification#timestamp-millisecond-precision" >}})) -* _local_timestamp_ms_ (logical type [local-timestamp-millis]({{< relref "specification#local_timestamp_ms" >}})) -* _uuid_ (logical type [uuid]({{< relref "specification#uuid" >}})) +* _decimal_ (logical type [decimal]({{< relref "../specification#decimal" >}})) +* _date_ (logical type [date]({{< relref "../specification#date" >}})) +* _time_ms_ (logical type [time-millis]({{< relref "../specification#time-millisecond-precision" >}})) +* _timestamp_ms_ (logical type [timestamp-millis]({{< relref "../specification#timestamp-millisecond-precision" >}})) +* _local_timestamp_ms_ (logical type [local-timestamp-millis]({{< relref "../specification#local_timestamp_ms" >}})) +* _uuid_ (logical type [uuid]({{< relref "../specification#uuid" >}})) For example: ```java @@ -261,7 +261,7 @@ record Card { ``` ### Default Values -Default values for fields may be optionally specified by using an equals sign after the field name followed by a JSON expression indicating the default value. This JSON is interpreted as described in the [spec]({{< relref "specification#schema-record" >}}). +Default values for fields may be optionally specified by using an equals sign after the field name followed by a JSON expression indicating the default value. This JSON is interpreted as described in the [spec]({{< relref "../specification#schema-record" >}}). ### Complex Types diff --git a/doc/content/en/docs/1.12.0/IDL Language/_index.md b/doc/content/en/docs/1.12.0/IDL Language/_index.md index 7d0121274a9..68c5605b7b3 100644 --- a/doc/content/en/docs/1.12.0/IDL Language/_index.md +++ b/doc/content/en/docs/1.12.0/IDL Language/_index.md @@ -222,12 +222,12 @@ The primitive types supported by Avro IDL are the same as those supported by Avr ### Logical Types Some of the logical types supported by Avro's JSON format are directly supported by Avro IDL. The currently supported types are: -* _decimal_ (logical type [decimal]({{< relref "specification#decimal" >}})) -* _date_ (logical type [date]({{< relref "specification#date" >}})) -* _time_ms_ (logical type [time-millis]({{< relref "specification#time-millisecond-precision" >}})) -* _timestamp_ms_ (logical type [timestamp-millis]({{< relref "specification#timestamp-millisecond-precision" >}})) -* _local_timestamp_ms_ (logical type [local-timestamp-millis]({{< relref "specification#local_timestamp_ms" >}})) -* _uuid_ (logical type [uuid]({{< relref "specification#uuid" >}})) +* _decimal_ (logical type [decimal]({{< relref "../specification#decimal" >}})) +* _date_ (logical type [date]({{< relref "../specification#date" >}})) +* _time_ms_ (logical type [time-millis]({{< relref "../specification#time-millisecond-precision" >}})) +* _timestamp_ms_ (logical type [timestamp-millis]({{< relref "../specification#timestamp-millisecond-precision" >}})) +* _local_timestamp_ms_ (logical type [local-timestamp-millis]({{< relref "../specification#local_timestamp_ms" >}})) +* _uuid_ (logical type [uuid]({{< relref "../specification#uuid" >}})) For example: ```java @@ -261,7 +261,7 @@ record Card { ``` ### Default Values -Default values for fields may be optionally specified by using an equals sign after the field name followed by a JSON expression indicating the default value. This JSON is interpreted as described in the [spec]({{< relref "specification#schema-record" >}}). +Default values for fields may be optionally specified by using an equals sign after the field name followed by a JSON expression indicating the default value. This JSON is interpreted as described in the [spec]({{< relref "../specification#schema-record" >}}). ### Complex Types diff --git a/doc/go.mod b/doc/go.mod index 6a69a014b4c..2837284801c 100644 --- a/doc/go.mod +++ b/doc/go.mod @@ -17,7 +17,7 @@ module github.com/apache/avro -go 1.22.6 +go 1.22 require ( github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7 // indirect