summaryrefslogtreecommitdiffstats
path: root/documentation/portal/portal-overview.asciidoc
diff options
context:
space:
mode:
authorMarkus Koivisto <markus@vaadin.com>2016-01-22 14:55:18 +0200
committerMarkus Koivisto <markus@vaadin.com>2016-01-22 14:55:18 +0200
commit99d6de546c74f0eed230ea8253dda6b85109d2e7 (patch)
tree10fc21c557566fe3241e6e13499df18d80f8dcb2 /documentation/portal/portal-overview.asciidoc
parent610736d9f373d4b37fd39ff8f90aabd13eab7926 (diff)
downloadvaadin-framework-99d6de546c74f0eed230ea8253dda6b85109d2e7.tar.gz
vaadin-framework-99d6de546c74f0eed230ea8253dda6b85109d2e7.zip
Add documentation to master branch
Change-Id: I2504bb10f1ae73ec0cbc08b7ba5a88925caa1674
Diffstat (limited to 'documentation/portal/portal-overview.asciidoc')
-rw-r--r--documentation/portal/portal-overview.asciidoc27
1 files changed, 27 insertions, 0 deletions
diff --git a/documentation/portal/portal-overview.asciidoc b/documentation/portal/portal-overview.asciidoc
new file mode 100644
index 0000000000..8368de1fe2
--- /dev/null
+++ b/documentation/portal/portal-overview.asciidoc
@@ -0,0 +1,27 @@
+---
+title: Overview
+order: 1
+layout: page
+---
+
+[[portal.overview]]
+= Overview
+
+Vaadin supports running UIs as portlets in a portal, as defined in the JSR-286
+(Java Portlet API 2.0) standard. A portlet UI is defined just as a regular UI,
+but deploying to a portal is somewhat different from deployment of regular web
+applications, requiring special portlet descriptors, etc. Creating the portlet
+project with the Vaadin Plugin for Eclipse or a Maven archetype automatically
+generates the necessary descriptors.
+
+In addition to providing user interface through the Vaadin UI, portlets can
+integrate with the portal to switch between portlet modes and process special
+portal requests, such as actions and events.
+
+While providing generic support for all portals implementing the standard,
+Vaadin especially supports the Liferay portal and the needed portal-specific
+configuration in this chapter is given for Liferay. Vaadin also has a special
+Liferay IPC add-on to enable communication between portlets.
+
+
+