Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 319251

Summary:	Virgo Web Server name used to describe Kernel confuses reader
Product:	[RT] Virgo	Reporter:	Pete Carapetyan <pete>
Component:	unknown	Assignee:	Glyn Normington <glyn.normington>
Status:	CLOSED FIXED	QA Contact:
Severity:	minor
Priority:	P3	CC:	glyn.normington, zteve.powell
Version:	unspecified
Target Milestone:	2.1.0.M05-incubation
Hardware:	All
OS:	All
Whiteboard:

Description Pete Carapetyan

2010-07-08 06:19:38 EDT

Build Identifier: 2.1.0.M01

Throughout the user documentation virgo-user-guide-incubation-2.1.0.M01.pdf, such as on the title page, in the table of contents of sections 1, 2, and 3, but also throughout the document itself, the server is referred to as the Virgo Web Server or alternately VWS. This is a great moniker, of course, but unfortunately it completely obfuscates the fact that VWS can be used as a web server or just a server. The web portion is completely optional, such as when I downloaded the server to use standalone.

The net effect is that the casual reader glancing through the table of contents or the document itself, if looking for how to operate the server as a standalone kernel, is led to believe from the Table of Contents or a scan of the doc titles or even the text itself, to "go away, there is nothing for you here." This despite the fact that in fact it's exactly what he needs, it is just all named in a misleading way.

This same problem is also repeated to a lesser degree in virgo-programmer-guide-incubation-2.1.0.M01.pdf (see title page, for example), and in the quick start - but in the quick start it may be appropriate because the sample app is a web app.

Reproducible: Always

Steps to Reproduce:
1. read pdf manuals from perspective of someone not interested in using tomcat or any web server.

Comment 1 Glyn Normington

2010-07-08 06:35:09 EDT

Thanks very much for raising this. I agree this is a significant issue as I would like the Virgo kernel to have its own life and use cases independently of the web server "application".

(Please note that unfortunately and only after significant work to try to get it going I had to remove PDFs from the latest milestone documents as the documentation build hangs producing the PDFs. This has no effect on this issue, but I thought I would mention it as you are clearly a reader of PDFs).

Comment 2 Pete Carapetyan

2010-07-08 08:07:15 EDT

Just a heads up on the pdfs - I'm just as comfortable with html versions, never really sure why I sometimes choose pdfs and sometimes choose html for the docs.

Comment 3 Steve Powell

2010-07-26 12:07:09 EDT

Pete: I'm looking at the documentation.

The references to Virgo Web Server in the user-guide are all parameterised; thus one solution is to make a blanket change (from Virgo Web Server to Virgo Server, perhaps?)

But this doesn't really meet the bill. Instead, some reworking of the docs is required, which clearly identifies what are Web Server personality features and what built-in features of the Kernel, and chooses the best reference in each place.  I think this will be a little bit of work :-)

Do you agree with this approach?

Are you able to make some specific suggestions?

Care to prioritise the user-guide vs the programmer-guide?

Comment 4 Glyn Normington

2010-09-17 06:23:24 EDT

Given the web server audience is likely to be larger than the kernel audience, the User Guide is on the whole unchanged. However, I have made several changes to emphasise the independence of the kernel from the web server and have added an introduction and a kernel installation chapter and have renamed some sections for clarity. I have also renamed the document to be the Virgo User Guide.

Similarly, I renamed the Programmer Guide and added an introductory note on the kernel to the preface.

Comment 5 Glyn Normington

2010-09-27 08:34:35 EDT

RC1 is planned instead of milestone 5.