sbt/sbt-native-packager

Redirect scala-sbt.org to readthedocs

Open

#1064 opened on Nov 5, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Scala (1,593 stars) (439 forks)batch import
documentationhelp wanted

Description

The docs published at http://www.scala-sbt.org/sbt-native-packager/ aren't up-to-date. Instead we should point http://sbt-native-packager.readthedocs.io/en/stable/

The tricky part will be to add the redirects for all existing pages to the new page without breaking the actual documentation generation.

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
sbtreadthedocsURL redirects
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate how the current documentation generation works in the sbt native packager repository. Look for build configuration files (e.g., build.sbt) that handle docs generation. Determine how to add redirects for all existing pages to the new readthedocs URL without breaking generation. Consider using a redirect plugin or server side configuration.