You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "Tanya Schlusser (JIRA)" <ji...@apache.org> on 2019/01/30 15:07:00 UTC

[jira] [Comment Edited] (ARROW-4427) Move Confluence Wiki pages to the Sphinx docs

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

Tanya Schlusser edited comment on ARROW-4427 at 1/30/19 3:06 PM:
-----------------------------------------------------------------

Hoo boy. A big task! Modified the description + title per discussion above.


was (Author: tanya):
Hoo boy. And all of their child wiki pages.

> Move Confluence Wiki pages to the Sphinx docs
> ---------------------------------------------
>
>                 Key: ARROW-4427
>                 URL: https://issues.apache.org/jira/browse/ARROW-4427
>             Project: Apache Arrow
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Tanya Schlusser
>            Priority: Major
>
> It's hard to find and modify the ["Contributing to Apache Arrow"|https://cwiki.apache.org/confluence/display/ARROW/Contributing+to+Apache+Arrow] and other developers' wiki pages in Confluence. If these were moved to inside the project web page, that would make it easier.
> There are 5 steps to this:
>  # Create a new directory inside of `arrow/docs/source` to house the wiki pages. (It will look like the [cpp|https://github.com/apache/arrow/tree/master/docs/source/cpp] or [python|https://github.com/apache/arrow/tree/master/docs/source/python] directories.)
>  # Copy the wiki page contents to new `*.rst` pages inside this new directory.
>  # Add an `index.rst` that links to them all with enough description to help navigation.
>  # Modify the Sphinx index page [`arrow/docs/source/index.rst`|https://github.com/apache/arrow/blob/master/docs/source/index.rst] to have an entry that points to the new index page made in step 3
>  # Modify the static site page [`arrow/site/_includes/header.html`|https://github.com/apache/arrow/blob/8e195327149b670de2cd7a8cfe75bbd6f71c6b49/site/_includes/header.html#L33] to point to the newly created page instead of the wiki page.
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)