Skip to content

Commit

Permalink
[NO-JIRA] Docs build fixes (#3108)
Browse files Browse the repository at this point in the history 
* 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 <mgrigorov@apache.org>

* 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 <mgrigorov@apache.org>

* 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 <mgrigorov@apache.org>

---------

Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
  • Loading branch information
@martin-g
martin-g authored Aug 22, 2024
1 parent ea2c54b commit f911408
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 18 deletions.
3 changes: 0 additions & 3 deletions doc/config.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions doc/content/en/docs/++version++/IDL Language/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions doc/content/en/docs/1.12.0/IDL Language/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f911408

Please sign in to comment.