[jira] [Commented] (SUBMARINE-518) [Umbrella] Overhaul Submarine Documentation And Website

["Wangda Tan (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SUBMARINE-518?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17117994#comment-17117994 ] 

Wangda Tan commented on SUBMARINE-518:
--------------------------------------

Here's the proposal:  

Make clear responsibilities between website and github docs: 
 * Website is responsible for:
 ** Showing the vision of the project. 
 ** Provide links to *User-Documentation(How to use, how to install, how to build)*/Download.
 ** Provide links to Github, Blogpost.
 * Roadmap is documented on WIKI:
 ** [https://cwiki.apache.org/confluence/display/SUBMARINE/Roadmap]
 ** The reason to put roadmap on Atlassian WIKI is, it is frequently changing, we want release managers can easier modify roadmaps. 
 ** Also, integration from confluent to Jira is helpful to track the release progress. 
 * Github is responsible for: 
 ** Source control of following contents: 
 *** Landing page of Github (README.md) should include following contents.
 **** (Short) Description of the project 
 **** Link to the User Documentation. 
 *** CONTRIBUTOR.md

> [Umbrella] Overhaul Submarine Documentation And Website
> -------------------------------------------------------
>
>                 Key: SUBMARINE-518
>                 URL: https://issues.apache.org/jira/browse/SUBMARINE-518
>             Project: Apache Submarine
>          Issue Type: Task
>            Reporter: Wangda Tan
>            Priority: Major
>
> Now we have a number of issues of our Documentation and Website: 
> 1) There's no enough distinguish between website / Github documentation. 
> 2) There's no site to host documentation based on versions. 
> We need find a way to solve this problem, that's the main purpose of the Jira. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org