[jira] [Commented] (BIGTOP-3773) Improve Bigtop's webpage and documentation with user-friendly contents

["Leona Yoda (Jira)" <ji...@apache.org>]

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

Leona Yoda commented on BIGTOP-3773:
------------------------------------

The issue above is a little bit ambiguous and my feeling might not be correct.

I'm a just a contributor, so please give me any advices.

> Improve Bigtop's webpage and documentation with user-friendly contents
> ----------------------------------------------------------------------
>
>                 Key: BIGTOP-3773
>                 URL: https://issues.apache.org/jira/browse/BIGTOP-3773
>             Project: Bigtop
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Leona Yoda
>            Assignee: Leona Yoda
>            Priority: Major
>
> Currently Bigtop's website is simple and documentation is maintained on Wiki.
> This works well in some sense, however,
>  * Users cannot check at a glance what kind of project they can package, test or deploy. This would not make good first impression on them.
>  * The documentations are not allays linked to Pull requests or other updates. It is complicated for users to trace the discussions on background. 
>  * Some contents seems old, probably because dropping a document is difficult without discussions.
> I would like to resolve the issue by dividing into small pieces, and with discussions.
>  * Listing user's and developer's other requests on this Jira Issue.
>  * Considering the table of contents (Sub task)
> At least it's worth checking nowadays contents.
>  ** Writing the contents with a fixed format (.md, .rst, or so on) (Sub-Sub task)
>  * Considering the webpage / document generator (Sub task) 
> Like other apache project doing, using generators is simple and have a lot of benefits.
> At least it's worth updating existing webpage and wiki through discussions.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)