New T5 site remarks
-------------------

                 Key: TAP5-1354
                 URL: https://issues.apache.org/jira/browse/TAP5-1354
             Project: Tapestry 5
          Issue Type: Improvement
          Components: documentation
            Reporter: Borut Bolcina


Hello,

first congratulations on a new site!

Today I needed some information about how to test my services, so I visited the 
new site and started browsing. Couldn't find the answer. Can someone give me 
some pointers here?

First I looked in the FAQ and searched for "test" within the page with my 
browser. Found 2 irrelevant hits, so I went on to the User guide. There is a 
section Test, but covers only testing of pages.

Inspecting further to Tapestry IOC and eye-balling for something useful I 
discovered a link to registry startup, which briefly mentions what would one 
want to use it:

"However, you may want to do some integration testing using the Registry from 
within a test case,"

I know there are projects out there, so you can inspect the source code to get 
an example of how to test the services, but I feel it should be better 
explained right on the offical page - at least in the FAQ section. It is very 
hard to embrace testing to start with, so some guidance is much appreciated.

And the red background links must go away.

The download section should include maven instruction, at least the dependency 
section of the pom should be listed.

There should be more room at the bottom between the last paragraph and the 
footer. The header on most pages is very "white", the bottom has no space at 
all. Give it some air.

Why is there a Book section in the Documentation with only one link to more 
books? It look like an error. At least last two books (their images and 
caption) should be there.

I like the ComponentCheetSheet! A sentance or two more on each annotation would 
be great.

The tutorial Setting up your environment should be improved. Alternatives 
should be described on how to run T5 apps in the Eclipse or other IDEs, but not 
in the text as that would make it too long. I think there should be links for 
alternative setups - like how to run the T5 app from a main class and even 
start VisualVM for early debugging and optimizing (each alternative has pros 
and cons). There is no mention of m2eclipse plugin. Of course one can use JDK 6 
also - only 1.5 is there. There is a sentence: "You should not have to download 
this directly". Why are then download links on the download page and no mention 
of maven at the same time. It is confusing for newbs.

The should also be a more visible link to T5 wiki somewhere.

I hope I wasn't too harsh, just wanna put my perspective.

-Borut

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to