docs: replace incorrect Maven artifact and module names
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
- 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-giraphwayang-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– Replacewayang-graphchiwithwayang-giraphand remove the incorrectwayang-kafkaartifact reference.
Repository: apache/wayang-website
docs/guide/examples.md:40– Updatewayang-apitowayang-api-scala-java.docs/guide/examples.md:41– Replacewayang-graphchiwithwayang-giraph.docs/guide/examples.md:112– Update thewayang-apimodule reference.
Proposed Changes
- Correct the Maven artifact and module references in the main README.
- Update the website examples documentation in the separate
apache/wayang-websiterepository. - Review other documentation files for similar incorrect references.
Additional Files to Review
python/src/pywy/tests/resources/sample_data.md:153wayang-applications/data/case-study/DATA_REPO_001/README.md:129wayang-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.xmlwayang-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
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/wayang
-
JavaReservoirSampleOperator returns the whole input when the dataset size is unknownPossibly taken @sasmith-14 claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/wayang#884 · 3 comments ·
Maintainers usually reply within 2 days
-
Record.compareTo() throws ClassCastException when comparing recordsPossibly taken @harshitsingh070 claimed this 69 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days
-
Unused parameter in function ProjectionDescriptor.createPojoJavaImplementation()Possibly taken @AliRana30 claimed this 77 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/wayang#732 · 3 comments ·
Maintainers usually reply within 2 days
-
DISCLAIMER and some "(incubating)" references are still around after graduationPossibly taken @sasmith-14 claimed this 1 day ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 66/100
apache/wayang#895 · 1 comment · 1 assignee ·
Maintainers usually reply within 2 days
-
SQL API: aggregates don't skip NULL values (COUNT(col) counts them, SUM and AVG throw NPE)Possibly taken @AarushShetty346 claimed this 4 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 20/100
Maintainers usually reply within 2 days
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
jenkins-infra/plugin-modernizer-tool#2070 · 1 comment ·
Maintainers usually reply within 1 day
-
Event search answers 500 when calendars, attendees or organizers holds a null elementMay be free again A pull request for this issue was closed without being merged. Openai-driven-qa bug Minor
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
linagora/twake-calendar-side-service#1615 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day