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

Stamatis Zampetakis commented on HIVE-28666:
--------------------------------------------

The PR#21 has everything obtained from the wiki export with the .html pages 
transformed in .md using the aforementioned script. It also includes some 
manual cleanup for errors/issues that was not easy to capture in the script. 

There are many obsolete pages and content that we probably need to revisit but 
this is out of the scope of this ticket. Once the migration is finished 
everyone can propose improvements which can be reviewed using the regular PR 
workflow. 

One question that remains open is what to do with the confluence space. We 
should either de-activate it or make it read-only with hopefully a message that 
indicates that the content there is obsolete.

> Migrate documentation from the wiki to the website
> --------------------------------------------------
>
>                 Key: HIVE-28666
>                 URL: https://issues.apache.org/jira/browse/HIVE-28666
>             Project: Hive
>          Issue Type: Task
>      Security Level: Public(Viewable by anyone) 
>          Components: Website
>            Reporter: Stamatis Zampetakis
>            Assignee: Stamatis Zampetakis
>            Priority: Major
>              Labels: pull-request-available
>         Attachments: html_to_markdown.py
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> Currently all documentation is hosted and maintained in the Confluence wiki 
> (https://cwiki.apache.org/confluence/display/Hive/Home). The wiki has certain 
> drawbacks that are not easy to circumvent. 
> 1. Contributions are cumbersome. New contributors have to request a wiki 
> account from INFRA and then the PMC must give additional karma to the user to 
> be able to modify the space.
> 2. Reviews are difficult. There is no built-in feature in Confluence that 
> allows to review changes before updating the content of the space.
> 3. History is hard to track. Although, versioning is supported at page level 
> finding who and when modified a part of the page is not straightforward. 
> Moreover, when pages get moved, deleted, etc., it's very hard or impossible 
> to track what happened. 
> 4. Limited access control. Any user with the basic permissions that are 
> usually given on-demand can modify any part of the space without anyone 
> realizing.
> The above shortcomings can be alleviated by putting the documentation under 
> the Website (https://hive.apache.org/) that is under version control (git).
> Shortcomings of confluence have appeared various times in discussions in the 
> dev list:
> * https://lists.apache.org/thread/58zhfdklq485c6942fj0lmpzmh8o9fch
> * https://lists.apache.org/thread/jcck8tdod3hyzf5wjzxzn075xn79st4h



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

Reply via email to