Bug 506362 - [Documentation] [User Experience] The in-repository documentation should get a makeover to facilitate information gathering
Summary: [Documentation] [User Experience] The in-repository documentation should get ...
Status: UNCONFIRMED
Alias: None
Product: Papyrus
Classification: Modeling
Component: Others (show other bugs)
Version: 3.0.0   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard: Documentation
Keywords: plan
Depends on:
Blocks:
 
Reported: 2016-10-21 12:24 EDT by Quentin Le Menez CLA
Modified: 2016-11-03 04:26 EDT (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Quentin Le Menez CLA 2016-10-21 12:24:42 EDT 

    


    


      



        
          Comment 1
        

        
          Quentin Le Menez CLA

        

        
        

        
          2016-10-21 12:54:24 EDT
        

      






The refactoring and strategies are still being reviewed and therefore there is not a clear plan for this change yet. This bug is a way to open the discussion about the necessary/future changes to improve the user experience.

    


    


      



        
          Comment 2
        

        
          Francois Le Fevre CLA

        

        
        

        
          2016-11-03 04:26:23 EDT
        

      






To my mind, user and developer doc should be located as closed as possible to the code: so inside the plugin they are dealing with. Then we need a documentation agregator for mediawiki, html and pdf generation.

We should use the maven/tycho mecanism to produce the documentation.
They are several patches where we have linked the TOC and mediawiki generation to the build process.
Moreover it could be good to generate a default user/developer web site for each release of the Papyrus. This is the case for all Papyrus Components. See [1,2,3]


[1]: https://www.eclipse.org/papyrus/components/sysml/
[2]: https://www.eclipse.org/papyrus/components/designer/
[3]: https://www.eclipse.org/papyrus/components/components/
[4]: https://www.eclipse.org/papyrus/components/robotml/