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

Remo Meier (JIRA) issues at jboss.org
Sat Apr 16 14:03:00 EDT 2016


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

Remo Meier commented on FORGE-2637:
-----------------------------------

thx for the help. Got the basics of first plugin up and running (Apache Olingo).

regarding documentation, a gradle example would be great. I installed it for both 2.x and 3.x. But did not manage to get it up and running. 
The 2.x version in the JBoss Develop Studio showed me only  "Maven" as buildSystem option. And the following command gave me a pom without any errors/warnings:

project-new --named demo --buildSystem Gradle

What is the general status of the gradle support? I noticed that for 3.x it is still in Alpha stage. At my company, all new projects are soon supposed to use Gradle.

And is there a possiblity to display the available parameters of a command from the command line? like "--help"? Similar to the wizard in the Dev Environments?

> 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