[ARROW-4481] [Website] Instructions for publishing web site are missing a step

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.13.0
• Component/s: Website
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/21037
• Assignee: Wes McKinney
• Reporter: Andy Grove
• Created: 05/Feb/19 13:28
• Updated: 11/Jan/23 07:34
• Resolved: 12/Feb/19 14:28

Description

The instructions for publishing the web site say to run the "scripts/sync_format_docs.sh" which copies the top level "format" directory to the "_docs" directory under site.

Existing files in "_docs" have references to markdown files in the "_docs/format" directory. For example, the IPC.md contains:

{% include_relative format/IPC.md %}

However my top level format directory does not contain this IPC.md, so I get errors when running jekyll and I have had to create some dummy markdown files as a workaround.

I investigated this a bit and I think there is some prerequisite step that isn't documented that would cause Sphinx to run and generate docs?

Issue Links

• links to: GitHub Pull Request #3620