[jbosstools-commits] JBoss Tools SVN: r26480 - trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US.

Author: irooskov(a)redhat.com Date: 2010-11-11 19:34:23 -0500 (Thu, 11 Nov 2010) New Revision: 26480 Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml Log: updated modeshape guide with feedback from tech review Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -5,14 +5,14 @@ ]> <bookinfo id="book-ModeShape_Tools_Reference_Guide-ModeShape_Tools_Reference_Guide"> <title>ModeShape Tools Reference Guide</title> - <subtitle>ModeShape tools allow you to interact with the contents of numerious ModeShape repositories.</subtitle> + <subtitle>ModeShape tools allows you to interact with the contents of numerious ModeShape repositories.</subtitle> <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> <pubsnumber>0</pubsnumber> <abstract> <para> - ModeShape provides a self-contained repository with the functionality to unify content from multiple external and storage systems. + ModeShape Tools provides the ability to publish and remove content from ModeShape repositories. </para> </abstract> <corpauthor> Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -6,7 +6,7 @@ <chapter id="chap-ModeShape_Tools_Reference_Guide-introduction"> <title>Introduction</title> <para> - ModeShape tools allows you to link your workspace to ModeShape repositories, publish and unpublish resources to the repositories and define what can and cannot be published and unpublished. + ModeShape tools allows you to publish and unpublish resources to the Modeshape repositories you have made available through your workspace. These repositories are persisted within the workspace, from session to session. </para> <para> The Modeshape registry is persisted from session to session. Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -13,10 +13,10 @@ To your applications, ModeShape looks and behaves like a regular JCR repository. Using the standard JCR API, applications can search, navigate and listen for changes in content. However, ModeShape retrieves its content by federating multiple back-end systems (such as databases, services and other repositories). This allows those systems to maintain ownership of the information, while ensuring the unified repository remains current. </para> <para> - ModeShape repositories can be used in a variety of applications. One such application is provisioning and management. In provisioning and management it is critical to understand and keep track of the metadata for models, databases, services, components, applications, clusters, machines, and other systems used in an enterprise environment. Governance takes that a step further, by also tracking the policies and expectations against which performance can be verified. In these cases, a repository is an excellent mechanism for managing this complex and highly-varied information. + ModeShape repositories can be used in a variety of applications. One such application is provisioning and management. In provisioning and management it is critical to understand and keep track of the metadata for models, databases, services, components, applications, clusters, machines, and other systems used in an enterprise environment. Governance takes this further, by also tracking the policies and expectations against which performance can be verified. In these cases, a repository is an excellent mechanism for managing this complex and highly-varied information. </para> <para> - A ModeShape repository doesn't have to be large and complex. It could just manage configuration information for an application, or provide a JCR interface on top of non-JCR systems. + A ModeShape repository doesn't have to be large and complex. It could be setup to only manage configuration information for an application, or provide a JCR interface on top of non-JCR systems. </para> </section> Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -5,9 +5,9 @@ ]>--> <section id="sect-ModeShape_Tools_Reference_Guide-Tasks-Publish_or_unpublish_a_resource"> - <title>Publish or unpublish a resorce</title> + <title>Publish or unpublish a resource</title> <para> - Having registered your ModeShape instances in <xref linkend="sect-ModeShape_Tools_Reference_Guide-Tasks-Register_a_new_repository"/>, you can now publish files to the repositories. + Having registered your ModeShape server instances in <xref linkend="sect-ModeShape_Tools_Reference_Guide-Tasks-Register_a_repository_on_a_new_server"/>, you can now publish files to the repositories on these servers. </para> <para> Right-clicking on one or more projects, folders, or files in your Eclipse workspace will display the context menu for those files. This menu will now include a ModeShape submenu that allows you to publish or unpublish the resources to your ModeShape repository. @@ -24,7 +24,7 @@ </mediaobject> </figure> <para> - To assist with the publishing or unpublishing of your resource, a wizard will appear when either of these options are selected. + The ModeShape publishing wizard is displayed when you select <guimenuitem>publish</guimenuitem> or <guimenuitem>unpublish</guimenuitem> from the context menu. </para> <figure id="ModeShape_publishing_wizard"> <title>ModeShape publishing wizard</title> @@ -35,8 +35,35 @@ </mediaobject> </figure> <para> - The publishing wizard (shown in <xref linkend="ModeShape_publishing_wizard"/>) and unpublishing wizard allows you to choose which ModeShape repository to interact with and displays the selected files the operation will be performed on. When a project or folder is selected all their included files are acted upon. + The publishing wizard (shown in <xref linkend="ModeShape_publishing_wizard"/>) allows you to choose which ModeShape repository to interact with and displays the selected files the operation will be performed on. When a project or folder is selected all their included files are acted upon. </para> + <warning> + <para> + When performing a publish operation, make sure you are aware of the following: + </para> + <itemizedlist> + <listitem> + <para> + If you publish a file to a ModeShape repository where a version of the same file has previously been published to the repository by you or someone else, the publishing action will overwrite the file currently in the repository. + </para> + </listitem> + </itemizedlist> + <para> + When performing an unpublish operation, make sure you are aware of the following: + </para> + <itemizedlist> + <listitem> + <para> + If you are interacting with a multi-user repository, the version of the file you are unpublishing may have been updated by someone else after you. + </para> + </listitem> + <listitem> + <para> + It is important to be positive a file is no longer necessary when unpublishing as the file in question will be deleted from the repository with this operation. + </para> + </listitem> + </itemizedlist> + </warning> <para> When publishing or unpublishing files, you can see the operation output in the <guilabel>Console</guilabel> view. The type of information that you can view includes the repository where the operation took place, how long the operation took, the outcome for each file included in the operation, a hyperlink that allows you to open the file in an Eclipse editor, and a ModeShape repository workspace URL. </para> Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -4,10 +4,10 @@ %BOOK_ENTITIES; ]>--> -<section id="sect-ModeShape_Tools_Reference_Guide-Tasks-Register_a_new_repository"> - <title>Register a new repository</title> +<section id="sect-ModeShape_Tools_Reference_Guide-Tasks-Register_a_repository_on_a_new_server"> + <title>Register a repository on a new server</title> <para> - Registering a new repository is achieved through the <guilabel>ModeShape</guilabel> view. To open the <guilabel>ModeShape</guilabel> view navigate to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. From the <guilabel>Show View</guilabel> dialog select the <guimenuitem>ModeShape</guimenuitem> folder followed by the <guimenuitem>ModeShape</guimenuitem> view and click <guibutton>OK</guibutton>. + Registering a repository on a new server is achieved through the <guilabel>ModeShape</guilabel> view. To open the <guilabel>ModeShape</guilabel> view navigate to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. From the <guilabel>Show View</guilabel> dialog select the <guimenuitem>ModeShape</guimenuitem> folder followed by the <guimenuitem>ModeShape</guimenuitem> view and click <guibutton>OK</guibutton>. </para> <figure> <title>Selecting the ModeShape view</title> @@ -31,6 +31,11 @@ <para> The <guilabel>New Server</guilabel> dialog will then appear asking for the URL of the server to connect and your authentication information. You can test your connection to the server by clicking the <guibutton>Test</guibutton> button and then clicking the <guibutton>Finish</guibutton> button to add the server to the <guilabel>ModeShape</guilabel> view. </para> + <note> + <para> + Upon testing the connection, if a connection cannot be established, the ModeShape server can still be created. Use the <guibutton>Reconnect</guibutton> button on the ModeShape View's toolbar to try and connect again at a later time. + </para> + </note> <figure> <title>The New Server dialog</title> <mediaobject> @@ -42,8 +47,14 @@ <para> Once the server with the ModeShape repository has been added three new options become available within the <guilabel>ModeShape</guilabel> view. These options allow you to <guilabel>Edit server properties</guilabel>, <guilabel>Delete a server from the server registry</guilabel> and <guilabel>Reconnect to the selected server</guilabel>. To perform one of these actions either right-click on a server and select from the presented menu of actions, or use the buttons beside the <guilabel>Create a new server</guilabel> button seen in <xref linkend="Adding_a_new_server_for_ModeShape_repositories"/>. </para> - <para> + <note> + <para> + It is possible for a ModeShape server instance to have numerious ModeShape repositories stored on it. Once you have registered a connection to the server you will have access to all ModeShape repositories on the server. You do not need to register a new connection for each repository on the same server. + </para> + </note> +<!-- The functionality to delete a resource from the workspace using the Modeshape view does not currently exist, but could in a future version --> +<!-- <para> The <guilabel>ModeShape</guilabel> view also allows you to remove files from a workspace. - </para> + </para> --> </section> Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml 2010-11-12 00:08:47 UTC (rev 26479) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml 2010-11-12 00:34:23 UTC (rev 26480) @@ -17,7 +17,7 @@ </mediaobject> </figure> <para> - To add a new file extention type or folder name to be filtered from publishing, click on the corresponding <guibutton>New</guibutton> button, enter the details and click the <guibutton>Apply</guibutton> button so that your preference changes are saved. + To add a new file extension type or folder name to be filtered from publishing, click on the corresponding <guibutton>New</guibutton> button, enter the details and click the <guibutton>Apply</guibutton> button so that your preference changes are saved. </para> <para> Removing an entry is conducted by selecting an entry from one of the lists in the <guilabel>Preferences</guilabel> dialog and clicking on the <guibutton>Remove</guibutton> button. Ensure that you click the <guibutton>Apply</guibutton> button so that your preference changes are saved. @@ -25,12 +25,9 @@ <para> As the <guilabel>Preferences</guilabel> dialog lists file types and folders that will never be published to a repository, it follows that those listed will never be unpublished. If you decide to never have a certain file type or folder publishable, though it has been in the past, ensure that all instances of these are unpublished before setting any preferences for the file type or folder. </para> - <para> - If you do not ensure all file types and folders that are never to be published are unpublished before setting the prefences, then you will be left with instances of these in your ModeShape repositories that cannot be unpublished unless your preferences are changed. - </para> <note> <para> - Publishing folders or files of a certain file type before setting any preferences inhibiting the publishing of these types can be a way of ensuring that these files will never be removed (unpublished) from your ModeShape repositories by accident or someone else. + Publishing folders or files of a certain file type before setting any preferences inhibiting the publishing of these file types, can be a way of ensuring that you will never remove these files (unpublish) from your ModeShape repositories by accident. However since preference settings are only local to your working environment, in a multi-user ModeShape repository someone else could still remove these files. </para> </note> </section>