-
Notifications
You must be signed in to change notification settings - Fork 445
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #443
Comments
Would you volunteer updating :) |
These are the very first steps that someone needs to begin using the plugin (I speak from experience, I've just tried). I'm sorry but it's a little frustrating when the first steps in documentation don't work and a maintainer asks that users figure it out for themselves and send patches for the docs... |
Per #395 relating to confusion about publishing docs for different (pre)release versions, if you could please explain the current documentation process/policy someplace for contributors (I might suggest |
You are absolutely right :( The transition phase to autoplugins create a bit of a mess in the documentation. I'll try to clean up the documentation this week (along with #438 ) and create Actually I have no experience with multiple-doc versions in sphinx and with sbt-site. So this will |
The plugin is great though! I'll try to help take a look at how SBT, Akka, etc. have done the versioned docs when time allows. |
FIX #443 Refactor documentation. Work in progress
Just had the chance to look and that is looking much better already! If I have the chance I'll try to pitch in with archetype docs or at least review work-in-progress. Happy New Year 😁 |
Documentation is outdated - references old plugin version, old sbt version, deprecated settings and ways of use.
E.g. http://www.scala-sbt.org/sbt-native-packager/GettingStartedApplications/MyFirstProject.html
references sbt 0.13.1, sbt-native-packager 0.8.0-M2, instead of deprecated "packageArchetype.java_application" usage should have "enablePlugins(JavaAppPackaging)"
Also, publishing generated packages as artifacts (deployment) is not covered in docs (see related SO question: http://stackoverflow.com/q/21558398/381140 )
The text was updated successfully, but these errors were encountered: