[forge-issues] [JBoss JIRA] (FORGE-2637) Documentation Updates

Remo Meier (JIRA) issues at jboss.org
Wed Apr 13 05:02:00 EDT 2016


    [ https://issues.jboss.org/browse/FORGE-2637?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13191045#comment-13191045 ] 

Remo Meier edited comment on FORGE-2637 at 4/13/16 5:01 AM:
------------------------------------------------------------

I noticed that one has been renamed from addon to forge-addon in 3.0.The websites mentions that forge 3.0 has been released. Is there an eclipse update site? because the jobs developer studio still has the old one. Some instructions in this regard would be helpful on the website. 

regarding command renaming: a deprecation mechanism (allow old command to be used for one major release, give warning on console) and stronger validation of input parameters could be helpful. In this example I used the command and ended up with just a war project.




was (Author: remmeier):
I noticed that one has been renamed from addon to forge-addon in 3.0.The websites mentions that forge 3.0 has been released. Is there an eclipse update site? because the jobs developer studio still has the old one.

regarding command renaming: a deprecation mechanism (allow old command to be used for one major release, give warning on console) and stronger validation of input parameters could be helpful. In this example I used the command and ended up with just a war project.



> Documentation Updates
> ---------------------
>
>                 Key: FORGE-2637
>                 URL: https://issues.jboss.org/browse/FORGE-2637
>             Project: Forge
>          Issue Type: Feature Request
>            Reporter: Remo Meier
>
> Jboss Forge looks very good from a technical perspective (thanks for all the work!). Documentation and maybe reach within the Java community could be a bit better. Maybe the former could help with the later. Here are just a few suggestions:
> 1. I found that the old documentation (1.1.x) gives a much better overview in writing a plugin (explains things like Facets). That should be integrated into the new documentation.
> 2. There are tutorials on Youtube, make sure to link them.
> 3. Website is sometimes a bit inefficient with spacing. Panels take away a lot of space. e.g. the news page. And please get rid of those beginner/intermediate/advanced labels...
> 4. A lot of things are "hidden" in the hands on lab, like the command reference.
> 5. Currently it is more of a collection of tutorials (sometimes with repeated content). I kind of miss the  "one" documentation of Forge. To get an idea, have for exmple a look at the Spring Boot documentation.



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)


More information about the forge-issues mailing list