Browse Source

Some additions to docs/

MeFisto94 9 years ago
parent
commit
dbd332246e
2 changed files with 44 additions and 0 deletions
  1. 21 0
      docs/maintaining.md
  2. 23 0
      docs/reporting_issues.md

+ 21 - 0
docs/maintaining.md

@@ -0,0 +1,21 @@
+# Maintaining the SDK  
+This document is _only_ for developers who intend to maintain the SDK.  
+If you don't fulfill this criteria, feel free to skip that part as it won't help you with anything.  
+Actually this is not a real document either but simply a collection of links, hints, notes, etc.  
+
+### How to Release a new Version
+Since we have automated builds with travis you only have to tag a commit and it will be released for you.  
+Keep in mind that I currently have the impression that you can only publish one release at a time.  
+The OAUTH Key for this deployment is found in the .travis.yml along with instructions on how to generate such a file. You only need this when I'm (MeFisto94) no longer permitted to push to the repo.  
+
+The build process with the netbeans installers (`ant build-installers`) is a bit fragile especially in Travis Environment (small diskspace, no root (because caching)) so handle with care.  
+
+### What has to be done for a new Version?
+Now this part is actually for me so I don't forget it :P  
+
+Change http://wiki.jmonkeyengine.org/doku.php/sdk:welcome:3_1 every tag to keep up with the version number and then save it as nbres:/com/jme3/gde/docs/sdk/welcome/local.html  
+
+### How to Upgrade Dependencies
+See `nbi/stub/ext/infra/build/products/README` for now. It will be included in the docs and so the README will only be a link to that.  
+
+See `resources/README.md` and `harness-override/README.md` for how to change the Netbeans Icon (on Windows)  

+ 23 - 0
docs/reporting_issues.md

@@ -17,6 +17,29 @@ From there you'll have a really simple process:
 That's basically it. No matter what, we will tell you what further information we need, just make sure to describe it as detailed as possible.  
 See also the following parts on what information you _could_ include depending on the Issue.  
 
+### Version Information
+This is quite important for any release (as long as you are not using the latest version. DOUBLE SUPER TRIPLE CHECK!), since the SDK releases are fast paced.  
+Note: The Welcome Screen doesn't tell the truth about this. It always shows the latest version available.  
+You can try to rely on the window title but the dead safe way is to open the SDK's log and look for information like:  
+```
+Running on jMonkeyEngine 3.1-alpha3
+* Branch: HEAD
+* Git Hash: 0b487ee
+* Build Date: 2016-03-14
+LWJGL 2.9.3 context running on thread jME3 Main
+* Graphics Adapter: null
+[...]
+OpenGL Renderer Information
+* Renderer: NVIDIA GeForce GT 650M OpenGL Engine
+[...]
+Audio Renderer Information
+* Device: Built-in Output
+[...]
+OpenAL EFX not available! Audio effects won't work.
+```
+
+Please also include the information on the About Screen (especially for Build Problems).
+
 ### Reporting Exceptions  
 From time to time, you might get an "Exception" being written in your SDK Console after you experienced an Issue.  
 It's important to not only copy the name of it but the full stacktrace (caused by xyz in line u, caught at ...).