docs: replace incorrect Maven artifact and module names

Open Beginner friendly
#898 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

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

Research direction

Start with README.md around line 186, which names wayang-graphchi and wayang-kafka, then docs/guide/examples.md in apache/wayang-website at lines 40, 41 and 112. Use wayang-docs/src/main/resources/index.md as the reference for correct module names. Done when the rg command from the issue finds no remaining wayang-graphchi, wayang-kafka or bare wayang-api matches, and Kafka mentions that describe Spark support are kept.

Written by the indexing model from the issue text.

Description

Description

Some documentation files reference Maven artifacts and modules that do not exist in the Apache Wayang repository. These incorrect references may cause confusion or build failures for users following the documentation.

This issue aims to correct these references to match the actual module names.

Incorrect References
  • wayang-graphchi → wayang-giraph
  • wayang-kafka → Remove the incorrect artifact reference. Kafka support itself remains available through the Spark platform.
  • wayang-api → wayang-api-scala-java
Affected Files

Repository: apache/wayang

  • README.md:186 – Replace wayang-graphchi with wayang-giraph and remove the incorrect wayang-kafka artifact reference.

Repository: apache/wayang-website

  • docs/guide/examples.md:40 – Update wayang-api to wayang-api-scala-java.
  • docs/guide/examples.md:41 – Replace wayang-graphchi with wayang-giraph.
  • docs/guide/examples.md:112 – Update the wayang-api module reference.
Proposed Changes
  1. Correct the Maven artifact and module references in the main README.
  2. Update the website examples documentation in the separate apache/wayang-website repository.
  3. Review other documentation files for similar incorrect references.
Additional Files to Review
  • python/src/pywy/tests/resources/sample_data.md:153
  • wayang-applications/data/case-study/DATA_REPO_001/README.md:129
  • wayang-plugins/wayang-ml/src/test/resources/README.md:168
Verification

Run the following command to identify remaining incorrect references in Markdown files:

rg -n --pcre2 'wayang-graphchi|wayang-kafka|wayang-api(?![-\w])' --glob '*.md'

Review any remaining matches and ensure that valid Kafka support references are not removed.

References
  • wayang-platforms/
  • pom.xml
  • wayang-docs/src/main/resources/index.md

The existing index.md already uses the correct module names and can serve as a reference.

Note: Changes to apache/wayang-website should be submitted through a separate pull request against that repository.

Dominant language
Java
Stars
284
Forks
143
Avg merge
2d 13h
Merged PRs (30d)
13

Getting set up

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.

More from apache/wayang

All issues in apache/wayang

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.