First cut at a getting started guide which is more useful than what we had #208
Conversation
* Complete first cut of configuration section. * Lay out the next two sections.
* Enable ~ to work for sphinx tasks * Rework the flow a bit * Add the first section on mappings to the getting started guide.
| * Configuring the JVM and the process | ||
| * Configuring the Application itself. | ||
|
|
||
| The native packager provides a direct hook into the generated scripts for JVM configuration. Let's make use of this. First, add the following to the ``src/universal/conf/jvmopts`` file in the project :: |
There was a problem hiding this comment.
Oh, I didn't come across this option yet. What should we enforce? src/templates/etc-default or the jvmopts ?
There was a problem hiding this comment.
Well, in this context this is not for a server but a client. So... I think it's ok.
I was planning to have a section on servers (which I think are more complicated starting out) later. WDYT?
There was a problem hiding this comment.
Ah, that totally makes sense. Splitting in two sections I think is the way to go.
There was a problem hiding this comment.
Done. I'll push the update shortly.
|
Overall this looks pretty good. Step-by-step is always nice, however living example projects are always helpful on your way. I'm currently trying to build some here, but I have no good idea how to integrate them inside the docs. I'm a bit confused of all the possibilities to change the jvm and application parameters :D
IMHO we should point out the differences or remove duplicated ways of doing things. |
|
Yeah, I guess let me think about that a bit. MAYBE we need two paths of docs: Getting started with Applications Because things differ slightly.... |
|
@muuki88 - Completed the getting started with Applications guide (I think). Comments welcome. I may need help with the server side, but I'll see what I can tackle shortly. |
```bash sudo apt-get install python-pip sudo pip install sphinx_bootstrap_theme ```
Wip/getting started guide additions
|
I think we can merge this one and add new stuff in a new PR |
|
k, let me remove the copyright quick :) |
|
well, have it not be just me, at least! |
* Bump to new sbt-site plugin with ~ support directly * remove Josh Suereth as only copyright holder.
|
Ok, ready for merge now. I'm going to issue a 0.7.0-RC2 off master once this is in. |
First cut at a getting started guide which is more useful than what we had
|
Sorry for letting you wait :( |
Trying to reorganize the website so that it's easier to get into the native packager and figure things out.
I need some help here. Spent a good bit of time on this first part to try to get it right. I think this may be enough of a start for some help. This is the last thing holding up the 0.7.0 release.
Review by @muuki88