[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-641) How-to configure a remote server with JBDS 8.1

[Martin Malina (JIRA)]

     [ https://issues.jboss.org/browse/TOOLSDOC-641?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Martin Malina reassigned TOOLSDOC-641:
--------------------------------------

    Assignee: Misha Ali  (was: Martin Malina)


Hi Misha,
here are some comments:

4. b. For the Controlled by: field, click the Filesystem and shell operations radio button option.
 - why limit users to this? I understand that this article probably intentionally only describes how to use the filesystem mode and not the management operations mode. But in this case I suggest mentioning it in the article at the beginning of the document.

c. Select the check box for the Server is externally managed. Assume server is started. field.
 - why? It is a relevant use case to use this, but why not instruct them to use the adapter fully (including server start/stop)? Again, if we only want to introduce this limited functionality, then I suggest we say that in the introduction.

d. "A server runtime environment must be selected before you can successfully create a server adapter and complete the server definition."
 - this is not true. Server runtime is not required for remote servers. Especially if you're trying to create a server that is externally managed with file system operations, all you really need is a connection to the remote host and the deployment location on the remote host.
I would probably suggest to instruct users to create the remote server without a runtime.

5. a. In the drop down menu, select the appropriate host in the Host field The default host is Local..
 - when a user tries this for the first time, most likely they will need to create a new host definition, so we should at least say something like "You may need to create a new host." or better, we could walk them through that dialog also (or at least briefly explain what types of servers are supported).

5. b. b. Specify the remote server’s base directory (the default value for this is the standalone directory within server home directory) in the Remote Server Base Directory field.
 - it would be good to point out here that it's a path relative to the one above. So the default is simply "standalone" and not the whole path as reading this text may suggest (but the screenshot does a good job clearing this up).

5. b. d. Click Next > to continue or Finish to conclude the new remote server configuration.
 - this sounds a little confusing - continue how? later I could see that this refers to step 6., but at the time of reading this it wasn't clear. Perhaps just add something like: to continue (optional step 6 - see below)?

6.
 - I would switch a. and b. to first say how to add a resource - at first you won't have anything to remote. But that's a minor thing.

Result: You have successfully configured a remote server. The new server is listed in the Servers tab. Right click the server to view operations, including Start to start the server.
 - here you suggest users use the Start operation, but if your server is "externally managed" - as you suggested in 4. c., then it has some implications - the Start operation will not actually start the server, but will just mark it as started and the web poller will check that the server is really running. But anyway, I recommend not instructing users to check that checkbox in 4. c.

Feel free to ping me if you have any questions.

> How-to configure a remote server with JBDS 8.1
> ----------------------------------------------
>
>                 Key: TOOLSDOC-641
>                 URL: https://issues.jboss.org/browse/TOOLSDOC-641
>             Project: Documentation for JBoss Tools and Developer Studio
>          Issue Type: Sub-task
>          Components: General documentation issues
>    Affects Versions: 4.2.3.Final
>            Reporter: Misha Ali
>            Assignee: Misha Ali
>             Fix For: 4.2.3.Final
>
>
> Requesting QE review for the following content:
> https://docs.google.com/a/redhat.com/document/d/1sd5_RaThCjbRxeA4D-YcYjXLYXl3U3zEzpxyjARXk18/edit?usp=sharing



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)