Skip to content
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

Closed
sslavic opened this issue Dec 15, 2014 · 7 comments
Closed

Update documentation #443

sslavic opened this issue Dec 15, 2014 · 7 comments
Labels
documentation Documentation should be extended or updated

Comments

@sslavic
Copy link

sslavic commented Dec 15, 2014

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 )

@muuki88 muuki88 added the documentation Documentation should be extended or updated label Dec 15, 2014
@muuki88
Copy link
Contributor

muuki88 commented Dec 15, 2014

Would you volunteer updating :)

@ches
Copy link

ches commented Dec 18, 2014

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...

@ches
Copy link

ches commented Dec 18, 2014

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 src/sphinx/README.md and/or a note in the main README), I can try to help as I get my build working.

@muuki88
Copy link
Contributor

muuki88 commented Dec 18, 2014

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
a new release this weekend with a new documentation.

Actually I have no experience with multiple-doc versions in sphinx and with sbt-site. So this will
take some time to get it working correctly.

@ches
Copy link

ches commented Dec 18, 2014

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.

@muuki88
Copy link
Contributor

muuki88 commented Dec 20, 2014

@ches / @sslavic I started refactoring the documentation. The archetype examples are not adjusted yet, but the rest is.

Feedback welcome: mukis.de/sbt-native-packager/

muuki88 added a commit that referenced this issue Dec 27, 2014
FIX #443 Refactor documentation. Work in progress
@ches
Copy link

ches commented Jan 2, 2015

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 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation should be extended or updated
Projects
None yet
Development

No branches or pull requests

3 participants