[jbosstools-issues] [JBoss JIRA] (JBIDE-13814) centralize all jboss tools build doc into a single place, using a single tech/markup

[Max Rydahl Andersen (JIRA)]

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

Max Rydahl Andersen commented on JBIDE-13814:
---------------------------------------------

I think its important we separate user docs from dev docs, these are *not* developer related:

http://www.jboss.org/tools/docs/
http://www.jboss.org/tools/docs/faq
http://docs.jboss.org/tools/
http://docs.jboss.org/tools/movies/

This is just an experiment and if it worked more for user docs:
https://docs.jboss.org/author/display/JBIDE/Home

Leaving only: 
https://community.jboss.org/en/tools/dev?view=documents
https://community.jboss.org/wiki/JBossToolsFAQ
https://github.com/jbosstools/jbosstools-target-platforms/wiki
https://github.com/jbosstools/jbosstools-build/wiki
http://www.jboss.org/tools/docs/testing.html  

The last one is especially out of place since noone can maintain it (besides those with login and patience for magnolia :)

I've created https://github.com/maxandersen/devdoc to see how having these docs in github would work like and I find it super nice compared to the above options because:

a) its editable online AND offline
b) you can do PR's against it

I still find it relevant to have repository specific wiki's/docs but that would be secondary but very specific to the repository docs.

The only downside to this living in github is the lack of comment support but I'm wondering if that couldn't just move to git pullrequests/issues on that specific repository.

I've written a quick contributing guide outlining the various ways to interact with this repo at https://github.com/maxandersen/devdoc/blob/master/CONTRIBUTING.adoc

If we think this is the way to go I can move it to gihub.com/jbosstools/jbosstools-devdoc and we can start moving/coping docs over.


                
> centralize all jboss tools build doc into a single place, using a single tech/markup 
> -------------------------------------------------------------------------------------
>
>                 Key: JBIDE-13814
>                 URL: https://issues.jboss.org/browse/JBIDE-13814
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: website
>    Affects Versions: 4.1.0.Alpha1
>            Reporter: Nick Boldt
>            Assignee: Nick Boldt
>              Labels: to_jbt_4.2.x
>
> Currently we have doc in many places:
> https://community.jboss.org/en/tools/dev?view=documents
> https://community.jboss.org/wiki/JBossToolsFAQ
> https://github.com/jbosstools/jbosstools-target-platforms/wiki
> https://github.com/jbosstools/jbosstools-build/wiki
> http://www.jboss.org/tools/docs/
> http://www.jboss.org/tools/docs/faq
> http://www.jboss.org/tools/docs/testing.html
> http://docs.jboss.org/tools/
> http://docs.jboss.org/tools/movies/
> https://docs.jboss.org/author/display/JBIDE/Home
> We should have doc in 1 place. Need to clean up, update, centralize, etc.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira