incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From romb...@apache.org
Subject svn commit: r1607087 - in /sling/site/trunk: content/documentation/development/ide-tooling.mdtext lib/view.pm
Date Tue, 01 Jul 2014 14:09:25 GMT
Author: rombert
Date: Tue Jul  1 14:09:25 2014
New Revision: 1607087

URL: http://svn.apache.org/r1607087
Log:
IDE tooling - add images, fix download links

Modified:
    sling/site/trunk/content/documentation/development/ide-tooling.mdtext
    sling/site/trunk/lib/view.pm

Modified: sling/site/trunk/content/documentation/development/ide-tooling.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/ide-tooling.mdtext?rev=1607087&r1=1607086&r2=1607087&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/ide-tooling.mdtext (original)
+++ sling/site/trunk/content/documentation/development/ide-tooling.mdtext Tue Jul  1 14:09:25
2014
@@ -59,10 +59,16 @@ All changes performed in the local works
 
 Creating a new Sling content project is easily done by using the new Sling Content Project
Wizard. To kick off, start by selected File -> New -> Project and select Sling Content
Project under the Sling category.
 
+![New content project step 1](ide-tooling/new-content-project-step-1.png)
+
 You will then be asked to name the project and select its location.
 
+![New content project step 2](ide-tooling/new-content-project-step-2.png)
+
 Finally, you can select whether to add the project to an existing server or create a new
one.
 
+![New content project step 3](ide-tooling/new-content-project-step-3.png)
+
 Once you press finish, the project will be created and deployed to the server.
 
 ### Converting existing projects
@@ -73,8 +79,12 @@ To mark a project as being a Sling conte
 
 In the Project Explorer view there is an additional 'jcr_root' contribution to the project.
It is denoted by a folder icon with a small web overlay. This contribution provides a logical
view over the repository content, taking into account JCR metadata. As such, .content.xml
files will be folded into the corresponding node.
 
+![Content navigator](ide-tooling/content-navigator.png)
+
 Node properties can be edited in a distinct JCR properties view.
 
+![JCR properties](ide-tooling/jcr-properties.png)
+
 ### filter.xml - workspace filter definition
 
 A content project does not synchronize all its contents to the workspace. Instead, it looks
for a filter.xml file which defines which content is included in synchronization operations.
More information about the filter.xml file format and semantics can be found at [FileVault
docs - Workspace Filter](https://jackrabbit.apache.org/filevault/filter.html).
@@ -83,6 +93,8 @@ A content project does not synchronize a
 
 To deploy a project on the server, open the Servers view and use the Add and Remove... dialog
to add one or more modules.
 
+![Add and Remove projects from server](ide-tooling/add-remove-projects.png)
+
 After content projects are deployed, each change will cause the changed resources to be updated
in the repository.
 
 ### Manual content sync
@@ -91,7 +103,11 @@ It is possible to manually import/export
 
 The export wizard is available under the Sling -> Export Content ... action.
 
-The import wizard is available under the Sling -> Export Content ... action.
+![Repository export](ide-tooling/repository-export.png)
+
+The import wizard is available under the Sling -> Import Content ... action.
+
+![Repository import](ide-tooling/repository-import.png)
 
 ## Bundle sync
 
@@ -101,12 +117,20 @@ The only requirement for bundle projects
 
 Creating a new Sling bundle project is easily done by using the new Sling Bundle Project
Wizard. This wizard is only available when the Maven-based integration is installed. To kick
off, start by selected File -> New -> Project and select Sling Bundle Project under
the Sling category.
 
+![New bundle project step 1](ide-tooling/new-bundle-project-step-1.png)
+
 The next page allows you to select the archetype to use. It's recommended to select the latest
version of the archetype.
 
+![New bundle project step 2](ide-tooling/new-bundle-project-step-2.png)
+
 You will be asked to configure the archetype's properties.
 
+![New bundle project step 3](ide-tooling/new-bundle-project-step-3.png)
+
 Finally, you can select whether to add the project to an existing server or create a new
one.
 
+![New bundle project step 4](ide-tooling/new-bundle-project-step-4.png)
+
 Once you press finish, the project will be created and deployed to the server.
 
 ### Converting existing projects
@@ -117,6 +141,8 @@ To mark a project as being a Sling bundl
 
 To deploy a project on the server, open the Servers view and use the Add and Remove... dialog
to add one or more modules.
 
+![Add and Remove projects from server](ide-tooling/add-remove-projects.png)
+
 After OSGi bundle projects are deployed, each change will cause the bundle to be redeployed
on the server.
 
 ## Troubleshooting
@@ -125,9 +151,15 @@ After OSGi bundle projects are deployed,
 
 All operations that are performed on the Sling launchpad are logged in the Sling console.
To view these operations, open the Eclipse console view and select Open Console -> Sling
Console.
 
+![Sling Console](ide-tooling/sling-console.png)
+
 Additional information can be obtained by enabling the Eclipse platform tracing facility.
To do so, open the Eclipse preferences and navigate to General -> Tracing. Make sure that
'Enable tracing' is checked and all options under 'Sling IDE Tooling' are enabled.
 
-Why do I get an errror about "No DS descriptor found at..."?
+![Tracing](ide-tooling/tracing.png)
+
+### Why do I get an errror about "No DS descriptor found at..."?
+
+![Missing SCR descriptors](ide-tooling/missing-scr-descriptors.png)
 
 Bundle deployment assumes that the OSGi bundle is packaged into the project's output directory.
This includes:
 
@@ -138,7 +170,7 @@ Bundle deployment assumes that the OSGi 
 
 One often-occuring situation is that a Maven project using the maven-scr-plugin generates
the descriptors outside of target/classes, typically in target/scr-plugin-generated. To fix
this, make sure that you're using the maven-scr-plugin 1.15.0 or newer and that you have not
set a custom outputDirectory.
 
-# Known issues
+## Known issues
 
 The content sync implementation tries to mimic the FileVault semantics as closely as possible.
However, it is possible that some more exotic content structures will not be handled properly.
Some of the problems we're are of are:
 

Modified: sling/site/trunk/lib/view.pm
URL: http://svn.apache.org/viewvc/sling/site/trunk/lib/view.pm?rev=1607087&r1=1607086&r2=1607087&view=diff
==============================================================================
--- sling/site/trunk/lib/view.pm (original)
+++ sling/site/trunk/lib/view.pm Tue Jul  1 14:09:25 2014
@@ -114,7 +114,7 @@ sub downloads {
     my $result = "|Artifact | Version | Binary | Source|\n|--|--|--|--|\n";
     my $maven = "|Artifact | Version | Binary | Source|\n|--|--|--|--|\n";
     my $launchpad = "| Artifact | Version | Provides | Package |\n|-|-|-|-|\n";
-    my $ide = "|Artifact | Version | Online update site | Zipped update site |\n|--|--|--|--|\n";
+    my $ide = "|Artifact | Version | Provides | Online update site | Zipped update site |\n|--|--|--|--|\n";
 
     my @lines = split( /\n/, $args{content} );
     @lines = sort @lines;



Mime
View raw message