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

Remo Meier (JIRA) issues at jboss.org
Mon Apr 11 10:58:00 EDT 2016


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

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

Thx for the quick reply. Gitbooks would sound great to me. I'm new to JBoss forge and have another/newbie perspective. So I could give feedback. If there is one place to go and can read everything about Forge, that would be quite helpful. 

Topics I missed:
- multi module setup (for larger projects)
- more extensive plugin developer guide (going to have to create a couple of those if Forge is a good fit), facets/plugins, overview of important facets.
- ... 

I will continue here with other topics along the way if that is ok.

> 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