[jbosstools-issues] [JBoss JIRA] Commented: (JBDS-1006) How to write documentation wiki article update

Anastasiya Bogachuk (JIRA) jira-events at lists.jboss.org
Tue Mar 23 07:41:46 EDT 2010


    [ https://jira.jboss.org/jira/browse/JBDS-1006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12521331#action_12521331 ] 

Anastasiya Bogachuk commented on JBDS-1006:
-------------------------------------------

The whole article structure is changed: all sub-articles are located on one page, similar,  one topic-related articles are united, the XML content  is verified and adjusted to exclude unnecessary tags added by the system automatically (that influenced the formatting). TOC will be created. 

> How to write documentation wiki article update 
> -----------------------------------------------
>
>                 Key: JBDS-1006
>                 URL: https://jira.jboss.org/jira/browse/JBDS-1006
>             Project: Developer Studio (JBoss Developer Studio)
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 2.1.0
>            Reporter: Svetlana mukhina
>            Assignee: Anastasiya Bogachuk
>             Fix For: LATER-doc
>
>   Original Estimate: 4 days
>  Remaining Estimate: 4 days
>
> Update the article - http://community.jboss.org/wiki/HowtowritedocumentationforJBDSandJBossTools in the following way:
> Docteam notes section should be split onto separate articles published under the main one (HowtowritedocumentationforJBDSandJBossTools) , e.g.:
> Project structure schema, Images, etc,
> Some paragraphs should be moved to other section (e.g. everything about jira - move to Doc JIRA)
> New articles should be added e.g. Highlighting, Capitalizing, Abbreviations, Syntax (contact Mukhina for more detailes)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


More information about the jbosstools-issues mailing list