spring-projects / spring-projects/spring-ai

Version 1.1.2, spring.io documentation #ETL Pipeline, JsoupDocumentReader is not provided with relevant dependency imports, and the documentation is wrong.

Open
#5,209 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage
Dominant language
Java
Stars
9.5k
Forks
2.9k
Avg merge
1d 7h
Merged PRs (30d)
6

Description

Bug description
Version 1.1.2, spring.io documentation #ETL Pipeline #HTML (JSoup), JsoupEocumentReader is not provided with relevant dependency imports, and the documentation is wrong.According to my tests, the following dependencies need to be imported:

        <!--jsoup document reader, document is not provided -->
        <dependency>
            <groupId>org.springframework.ai</groupId>
            <artifactId>spring-ai-jsoup-document-reader</artifactId>
        </dependency>

Before importing the above dependencies, there was no JsoupDocumentReader:

Image

The screenshot of the actual part of the document is as follows:

Image

Environment
Spring AI version: 1.1.2 Java version : JDK 17

Expected behavior
I Expected join dependency in actual part of the document is as follows:

        <!--jsoup document reader, document is not provided -->
        <dependency>
            <groupId>org.springframework.ai</groupId>
            <artifactId>spring-ai-jsoup-document-reader</artifactId>
        </dependency>

Minimal Complete Reproducible example

Image

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

Open the spring.io ETL Pipeline documentation at the HTML (JSoup) section and review the dependency example against the JsoupDocumentReader usage described in the issue. Update the example to include the spring-ai-jsoup-document-reader dependency, then verify that the documented imports and dependency are consistent with Spring AI 1.1.2.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.