apache / apache/rocketmq

[Doc] Gradle snippets in the quick-start docs use the removed compile configuration

Open Beginner friendly
#11,159 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
22.6k
Forks
12k
Avg merge
3d 1h
Merged PRs (30d)
27

Description

### Search before creation

- [x] I had searched in the [issues](https://github.com/apache/rocketmq/issues) and found no similar issues.

### Documentation Related

The quick-start docs give the Gradle dependency as:

```
compile 'org.apache.rocketmq:rocketmq-client:5.5.0'
```

Gradle removed the `compile` configuration in 7.0, so this no longer works. Reproduced on Gradle 9.7.1 with an otherwise empty `java` project:

```
* What went wrong:
A problem occurred evaluating root project '...'.
> Could not find method compile() for arguments [org.apache.rocketmq:rocketmq-client:5.5.0] on object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler.
```

The error doesn't hint at the cause. Gradle's own suggestions are just `--stacktrace` / `--info` / `--scan`, and it fails while evaluating the project, so it reads like a method-name typo rather than a removed configuration. Swapping in `implementation` builds fine and resolves `rocketmq-client:5.5.0` along with its transitive dependencies from Maven Central, so the coordinates and the version in the docs are correct and only the configuration name is stale.

Affected files:

- `docs/en/Example_Simple.md`
- `docs/cn/Example_Simple_cn.md`
- `docs/cn/RocketMQ_Example.md`

The Maven blocks right above them are fine. Since the repo builds with Maven and Bazel only, no CI job ever looks at these snippets, which is probably how it drifted.

I checked the in-flight docs PRs first. #10436 and #10409 both touch these same lines, but they only bump the version number inside the snippet and keep `compile`, so this doesn't overlap with them.

### Are you willing to submit PR?

- [x] Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Open the Gradle snippets in docs/en/Example_Simple.md, docs/cn/Example_Simple_cn.md, and docs/cn/RocketMQ_Example.md, comparing them with the Maven blocks nearby. Update the removed configuration name to the working one while preserving the rocketmq-client:5.5.0 coordinates, then check all three snippets for consistent wording and formatting.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.