spring-projects / spring-projects/spring-data-mongodb

Fix Antora reference warnings

Open
#4,966 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: documentation
Dominant language
Java
Stars
1.7k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

[INFO] [08:33:01.434] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 5.0.x | start path: src/main/antora)
[INFO] [08:33:01.453] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 5.0.x | start path: src/main/antora)
[INFO] [08:33:01.597] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 5.0.0-M2 | start path: src/main/antora)
[INFO] [08:33:01.708] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 5.0.0-M2 | start path: src/main/antora)
[INFO] [08:33:01.708] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 5.0.0-M2 | start path: src/main/antora)
[INFO] [08:33:02.620] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 5.0.0-M2 | start path: src/main/antora)
[INFO] [08:33:02.748] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 5.0.0-M2 | start path: src/main/antora)
[INFO] [08:33:02.778] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: main | start path: src/main/antora)
[INFO] [08:33:02.893] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: main | start path: src/main/antora)
[INFO] [08:33:02.894] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: main | start path: src/main/antora)
[INFO] [08:33:03.649] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: main | start path: src/main/antora)
[INFO] [08:33:03.684] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: main | start path: src/main/antora)
[INFO] [08:33:03.801] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.5.0-RC1 | start path: src/main/antora)
[INFO] [08:33:03.934] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.5.0-RC1 | start path: src/main/antora)
[INFO] [08:33:03.935] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.5.0-RC1 | start path: src/main/antora)
[INFO] [08:33:04.697] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.5.0-RC1 | start path: src/main/antora)
[INFO] [08:33:04.717] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.5.0-RC1 | start path: src/main/antora)
[INFO] [08:33:04.861] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.4.x | start path: src/main/antora)
[INFO] [08:33:05.210] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.4.x | start path: src/main/antora)
[INFO] [08:33:05.211] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.4.x | start path: src/main/antora)
[INFO] [08:33:05.642] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.4.x | start path: src/main/antora)
[INFO] [08:33:05.821] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.4.x | start path: src/main/antora)
[INFO] [08:33:05.861] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.4.5 | start path: src/main/antora)
[INFO] [08:33:06.189] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.4.5 | start path: src/main/antora)
[INFO] [08:33:06.189] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.4.5 | start path: src/main/antora)
[INFO] [08:33:06.618] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.4.5 | start path: src/main/antora)
[INFO] [08:33:06.803] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.4.5 | start path: src/main/antora)
[INFO] [08:33:06.835] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.3.x | start path: src/main/antora)
[INFO] [08:33:07.114] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.3.x | start path: src/main/antora)
[INFO] [08:33:07.115] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.3.x | start path: src/main/antora)
[INFO] [08:33:07.542] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.3.x | start path: src/main/antora)
[INFO] [08:33:07.710] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (branch: 4.3.x | start path: src/main/antora)
[INFO] [08:33:07.743] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.3.11 | start path: src/main/antora)
[INFO] [08:33:08.045] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.3.11 | start path: src/main/antora)
[INFO] [08:33:08.045] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.3.11 | start path: src/main/antora)
[INFO] [08:33:08.476] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.3.11 | start path: src/main/antora)
[INFO] [08:33:08.642] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.3.11 | start path: src/main/antora)
[INFO] [08:33:08.673] INFO (asciidoctor): possible invalid reference: compatibility.changes
[INFO]     file: src/main/antora/modules/ROOT/pages/preface.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.2.12 | start path: src/main/antora)
[INFO] [08:33:08.948] INFO (asciidoctor): possible invalid reference: core.web
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.2.12 | start path: src/main/antora)
[INFO] [08:33:08.949] INFO (asciidoctor): possible invalid reference: core.web.basic.jackson-mappers
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/geo-json.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.2.12 | start path: src/main/antora)
[INFO] [08:33:09.391] INFO (asciidoctor): possible invalid reference: repositories.limit-query-result
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/repositories/modifying-methods.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.2.12 | start path: src/main/antora)
[INFO] [08:33:09.525] INFO (asciidoctor): possible invalid reference: mapping.index-creation
[INFO]     file: src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc
[INFO]     source: https://github.com/spring-projects/spring-data-mongodb (tag: 4.2.12 | start path: src/main/antora)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the invalid references in src/main/antora/modules/ROOT/pages/mongodb/mapping/mapping.adoc, mongodb/repositories/modifying-methods.adoc, preface.adoc, and mongodb/geo-json.adoc. Trace each reference target across the listed branches and tags, then rebuild the Antora documentation to confirm the possible invalid reference warnings are gone.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.