Merge pull request #51 from huitseeker/maintenance/release-upgrade

Additions to the Documentation tied to the 3.0.0 release.

src/sphinx/3.0.x/faq/known-issues.rst

@@ -1,6 +1,24 @@
 Know Issues
 -----------
 
+Do Not Enter road sign when opening a Scala Editor
+..................................................
+
+**Symptoms**:
+
+When opening a Scala editor, the error "Could not open the editor: org.eclipse.jdt.internal.core.CompilationUnit cannot be cast to scala.tools.eclipse.InteractiveCompilationUnit" (or something similar) appears.
+
+**Solution**:
+
+The Scala IDE uses weaving to behave as (much) more than a Java editor on Scala files, and this is the message you get when it is not active.
+
+JDT weaving is activated by default. Moreover, Scala plugin
+checks it is activated at every launch. The easiest way to debug
+this is therefore to accept activation of JDT weaving at
+launch. Otherwise, you can look into turning it on manually using
+the :doc:`Scala Diagnostics Dialog
+</current-user-doc/advancedsetup/index>`.
+
 Scala errors on all Unicode arrows
 ..................................
 

src/sphinx/3.0.x/features/navigating/comment-hyperlinking.rst

@@ -0,0 +1,13 @@
+.. include:: /global_defs.hrst
+
+URL Hyperlinking in Comments |new|
+==================================
+
+.. note::
+
+	Comment URL detection needs an ``http://`` prefix to be present
+
+If you enter an URL in a multi-line comment, it will be
+clickable. Hovering on it will also bring up the menu seen below.
+
+.. image:: images/url-hyperlinking.png

src/sphinx/3.0.x/features/navigating/index.rst

@@ -6,7 +6,8 @@ Navigating
 .. toctree::
    :maxdepth: 2
 
+   comment-hyperlinking
    declaration-hyperlinking
    implicit-hyperlinking
    open-type
-   open-declaration
+   open-declaration

src/sphinx/3.0.x/features/typingviewing/index.rst

@@ -11,6 +11,7 @@ Typing and Viewing
    code-templates
    formatting/index
    implicit-highlighting/index
+   javadoc
    mark-occurrences
    quick-fixes
    refactoring/index
@@ -19,4 +20,4 @@ Typing and Viewing
    show-inferred-semicolons
    source-generators/index
    structured-selection
-   syntax-highlighting
+   syntax-highlighting

src/sphinx/3.0.x/features/typingviewing/javadoc.rst

@@ -0,0 +1,11 @@
+.. include:: /global_defs.hrst
+
+Javadoc on hover
+================
+
+When hovering on a Java element, the javadoc view, if you have it
+open, will show you the documentation for it. Below you can see
+the result when hovering on an ``IJavaProject`` (part of the
+Eclispe JDT).
+
+.. image:: images/javadoc.png

src/sphinx/3.0.x/features/typingviewing/structured-selection.rst

@@ -9,3 +9,6 @@ Using ``alt+shift+up`` and ``alt+shift+down`` selects larger or smaller portion
 	Shortcuts are platform-dependent, and can be re-configured in the ``Keys`` preference page. The actions are named **Select Enclosing Element** and **Restore Last Selection**.
 
 .. image:: images/feature-structured-selection-01.png
+
+This feature will also benefit from hover typing, just as when
+you place the cursor on a specific element.

src/sphinx/contribute.rst.inc

@@ -2,3 +2,6 @@
 
    This documentation could use your help to grow and be refined. It is managed as a GitHub project at http://github.com/scala-ide/docs. Use the different available :doc:`tools </community>` to communicate with development team.
 
+.. note::
+
+       The documentation is redacted using `reStructuredText markup language <http://docutils.sourceforge.net/rst.html>`_ (reST). As with other `markup languages <http://en.wikipedia.org/wiki/Markup_language>`_, reST is the moral descendant of DocBook, and intended to be a lightweight way to structure text without having to deal with the presentation details involved in HTML. You can find references and tools for editing reST on its `wikipedia page <http://en.wikipedia.org/wiki/ReStructuredText>`_.

src/sphinx/dev/workflow/workflow.rst

@@ -108,6 +108,63 @@ Of course, after sending a pull request, you can immediately start working on a
 
   or scan and email to `[email protected] <mailto:[email protected]>`_.
 
+Continuous Integration
+......................
+
+Any pull request against the Scala-IDE repository will provide a
+set of changes. The Scala IDE formed by integrated your changes
+(i.e. the outcome of a pull request merge) will be built
+automatically, and have the test suite run on it as part of the
+build. This is accomplished using a `Jenkins
+<http://jenkins-ci.org/>`_ continuous integration server, hosted
+on `scala-ide.org
+<https://jenkins.scala-ide.org:8496/jenkins/>`_. There are
+actually several pull request validation jobs, each built using a
+specific software stack (including IDE dependencies such as
+`Scala Refactoring
+<https://github.com/scala-ide/scala-refactoring>`_) based on a
+distinct version of Scala — usually the latest stable Scala
+release and the upcoming one. The pull request validation jobs
+are named with strict conventions, and can be found listed with
+the prefix ``pr-validator-`` on the `integration server
+<https://jenkins.scala-ide.org:8496/jenkins/>`_.
+
+Interacting with the Jenkins server, and reporting the results of
+builds from Jenkins back to Github, is the role of the Typesafe
+pull request validator, affectionately nicknamed "the build
+kitteh". The source code for that piece of software is `available
+on Github
+<https://github.com/typesafehub/ghpullrequest-validator/>`_. It
+draws its name from the internet meme of `LOLcats
+<http://knowyourmeme.com/memes/lolcats>`_, started by the website
+`icanhascheezeburger.com <http://icanhas.cheezburger.com/>`_, of
+which it borrows humorous messages featuring cats bedridden with
+poor grammar. We in the Scala-IDE community are cat lovers, and
+the humorous pictures help us deal with the temporary setbacks
+on the road to excellent, bug-free software !
+
+In order to be merged, your pull request will be expected to
+build against the tested versions of the IDE, or to have a
+spectacularly good reason not do so. You will be expected to
+investigate and fix any failure of the build kitteh to build and
+test your code, as all Scala IDE developers do.
+
+.. note::
+
+       If your pull request required further changes as a result
+       of a failed build, please add more commits but do not
+       `force push
+       <https://help.github.com/articles/dealing-with-non-fast-forward-errors>`_
+       against the branch your pull request is issued from. From
+       the moment your pull request is issued, you can consider
+       it public and shared by reviewers (and the build kitteh),
+       something that does not play well with trying to rewrite
+       history. If it is absolutely necessary to rewrite what you
+       submitted as a pull request, please consider closing your
+       pull request and re-opening another. You can trigger
+       another build from the kitteh (e.g. after making a few
+       additions) by commenting against your pull request with
+       the string ``PLS REBUILD ALL``.
 
 Committers
 ----------
@@ -171,4 +228,4 @@ mainline:
 Now you are ready to hack on a new ticket ;)
 
 If anything above is unclear, please make sure to ask in the `scala-ide-dev 
-<https://groups.google.com/group/scala-ide-dev?hl=en>`_ mailing list for clarification.
+<https://groups.google.com/group/scala-ide-dev?hl=en>`_ mailing list for clarification.