docs: replace incorrect Maven artifact and module names

Đang mở Phù hợp với người mới
#898 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java, scala
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với README.md quanh dòng 186, nơi nêu wayang-graphchi và wayang-kafka, sau đó là docs/guide/examples.md trong apache/wayang-website ở các dòng 40, 41 và 112. Dùng wayang-docs/src/main/resources/index.md làm tham chiếu cho tên module chính xác. Hoàn thành khi lệnh rg từ issue không còn tìm thấy kết quả khớp nào của wayang-graphchi, wayang-kafka hay wayang-api đứng riêng, và các đề cập đến Kafka mô tả hỗ trợ Spark được giữ nguyên.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Java
Star
284
Fork
147
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
13

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/wayang

Tất cả issue của apache/wayang

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.