sbt / sbt/sbt-eclipse

Documentation bug for installing sbteclipse v.2.5.0 for sbt version 0.13

Open
#215 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
712
Forks
163
PR merge metrics
No merged PRs in 30d

Description

Very important! This documentation error messed me up for many hours.

If you do not happen to land on the correct documentation page, your "sbt eclipse" command will never work on Linux or Windows.

The correct location for "plugins.sbt" is here:

 ~/.sbt/0.13/plugins/plugins.sbt

This page had the correct info as of July 4, 2014, with respect to sbteclipse v.2.5.0:

https://github.com/typesafehub/sbteclipse

The "Dec 19, 2013" version of this page is INCORRECT:

https://github.com/typesafehub/sbteclipse/wiki/Installing-sbteclipse

There are many other people getting messed up by this simple installation headache. Just Google this

 sbt "Not a valid project ID" eclipse

and you'll see what I mean.

Contributor guide

No contributing guide indexed for this repository

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

Start with the Installing-sbteclipse wiki page and compare it with the sbteclipse project page linked in the report. Verify the documented plugins.sbt location for sbt 0.13 and update the installation instructions so the sbt eclipse command can be followed successfully.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.