You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "Neal Richardson (Jira)" <ji...@apache.org> on 2020/06/11 18:44:00 UTC
[jira] [Commented] (ARROW-4427) [Doc] 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=17133578#comment-17133578 ]
Neal Richardson commented on ARROW-4427:
----------------------------------------
I'm going to mark this as resolved and we can make specific issues for bringing over any additional pages, though I'm not sure that there's anything else left that needs to be moved.
> [Doc] 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
> Assignee: Neal Richardson
> Priority: Major
> Fix For: 1.0.0
>
>
> 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
(v8.3.4#803005)