[Docs] Fix broken markdown formatting, leaked reviewer prompt, and outdated URLs in tutorial.md

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start in guides/tutorial.md, especially lines 23, 29, and 86–125, and inspect the final Java example for fence closure. Remove the leaked reviewer prompts, close the SQL and Java fences, update the repository path and clone command, and change snapshot references to 1.1.2-SNAPSHOT. Done means the tutorial renders correctly and all setup instructions match the current project.

Written by the indexing model from the issue text.

Description

Problem Description

In guides/tutorial.md, recent commits introduced formatting corruptions and left outdated setup instructions:

  1. Prompt Artifact Leakage & Broken Code Fences: Lines 86–125 contain unclosed ```sql and ```java code fences, along with raw reviewer prompts accidentally committed into the text:
    • ## 👉 Step 2 — Improve SQL execution step
    • Below this:
    • ```md
    • The final Java code example at EOF is missing its closing fence.
  2. Deprecated Incubator Clone URLs: Lines 23 and 29 instruct users to clone https://github.com/apache/incubator-wayang.git and cd incubator-wayang, which is obsolete following Wayang's graduation.
  3. Stale Snapshot References: References to wayang-assembly-1.1.1-SNAPSHOT-dist.tar.gz and wayang-1.0.1-SNAPSHOT do not match the current project version (1.1.2-SNAPSHOT).
Proposed Solution
  • Remove the prompt artifact text and properly format/close all SQL and Java code blocks.
  • Update repository URLs to https://github.com/apache/wayang.git and cd wayang.
  • Sync snapshot version strings to 1.1.2-SNAPSHOT.
Dominant language
Java
Stars
274
Forks
141
Avg merge
5d 16h
Merged PRs (30d)
4

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.

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.