playframework / playframework/playframework.com

Fix documentation for Play1 maven module

Open
#26 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status:backlog
Dominant language
Scala
Stars
44
Forks
62
Avg merge
1d 8h
Merged PRs (30d)
3

Description

In play1 we have an issue for a module documentation Play1 issue #1299
In the maven module page

We should replace

play mvn:source // or play mvn:src

by

play mvn:sources // or play mvn:src

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.

Research direction

Open the maven module page linked in the issue and inspect the documented commands. Replace the incorrect play mvn:source example with play mvn:sources, while retaining the play mvn:src alternative. Done means the page shows the corrected command and no longer repeats the reported documentation error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.