Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Move Confluence Wiki pages to the Sphinx docs #20988

Closed
asfimport opened this issue Jan 30, 2019 · 7 comments
Closed

[Doc] Move Confluence Wiki pages to the Sphinx docs #20988

asfimport opened this issue Jan 30, 2019 · 7 comments

Comments

@asfimport
Copy link
Collaborator

asfimport commented Jan 30, 2019

It's hard to find and modify the "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:

  1. Create a new directory inside of arrow/docs/source to house the wiki pages. (It will look like the cpp or python directories.)

  2. Copy the wiki page contents to new \*.rst pages inside this new directory.

  3. Add an index.rst that links to them all with enough description to help navigation.

  4. Modify the Sphinx index page arrow/docs/source/index.rst to have an entry that points to the new index page made in step 3

  5. Modify the static site page arrow/site/_includes/header.html to point to the newly created page instead of the wiki page.

     

Reporter: Tanya Schlusser / @tanyaschlusser
Assignee: Neal Richardson / @nealrichardson

Related issues:

Note: This issue was originally created as ARROW-4427. Please see the migration documentation for further details.

@asfimport
Copy link
Collaborator Author

Antoine Pitrou / @pitrou:
I think this would be better moved to the Sphinx docs, which allow extensive cross-referencing. IMHO the Jekyll site should only be used for top-level pages and the blog.

See https://github.com/apache/arrow/tree/master/docs

@asfimport
Copy link
Collaborator Author

Wes McKinney / @wesm:
+1

@asfimport
Copy link
Collaborator Author

Tanya Schlusser / @tanyaschlusser:
Ok. Am I understanding that maybe a number of the wiki pages should be moved—anything not directly related to Jira? So:

@asfimport
Copy link
Collaborator Author

Tanya Schlusser / @tanyaschlusser:
Hoo boy. A big task! Modified the description + title per discussion above.

@asfimport
Copy link
Collaborator Author

Wes McKinney / @wesm:
I'm tackling moving the contributor guide to Sphinx for ARROW-4425

@asfimport
Copy link
Collaborator Author

Wes McKinney / @wesm:
Seems like we've made a little progress here, but there's more to do

@asfimport
Copy link
Collaborator Author

Neal Richardson / @nealrichardson:
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants