playframework / playframework/play-samples

Converge tutorials (eliminate duplication)

Open
#84 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
554
Forks
548
Avg merge
1d 11h
Merged PRs (30d)
57

Description

We have multiple copies of tutorial/starter content. Some of that content is in the the play-xxx-start-example some of the content is in https://www.playframework.com/documentation/2.8.x/HelloWorldTutorial (backed by https://github.com/playframework/playframework/blob/master/documentation/manual/tutorial/HelloWorldTutorial.md).

Each writeup includes snippets maintained on each of the repos. The snippets not only are duplicate across repos, but the twirl templates are also duplicate between the play-xxx-start-example samples.

The welcome.scala.html templates also include introductions/tutorial contents and even copy/pasted snippets from the HomeController and the main.scala.html.

Summing up, as an example, a change in main.scala.html requires sync'ing code in 5 places:

  • 2x twirl templates on each of the samples
  • 2x welcome pages on each of the samples
  • 1x on the snippets of the documentation backing playframework.com's tutorial

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

Begin by comparing documentation/manual/tutorial/HelloWorldTutorial.md with the play-xxx-start-example content, including welcome.scala.html, main.scala.html, and HomeController snippets. Map the duplicated tutorial and Twirl content across the samples and documentation; done means the tutorial has a single maintained source rather than requiring updates in five places.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation, web-dev
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.