Skip to content

Commit

Permalink
ARROW-4339: [C++][Python] Developer documentation overhaul for 0.13 r…
Browse files Browse the repository at this point in the history
…elease

This was pretty much a huge pain but addresses accumulated documentation debt after the conda compiler migration and the CMake refactor. I suggest we not stress too much over small details on this and do more work to improve these docs in follow up PRs. I did the best I could under the circumstances and need to move on to other things now

I think the overall organization of the Sphinx project for developers is much improved, take a look (I will post a link to a published version for review)

JIRAs addressed by this PR and other things I did

* Update cpp/thirdparty/README.md given CMake refactor (this was totally out of date). This now directs users to the Sphinx C++ developer guide

* ARROW-4339: Move cpp/README.md to Sphinx documentation (and clean it up a lot!!)
* ARROW-4425: Move Contributing Guidelines from Confluence to Sphinx, update top level README
* ARROW-4232: Remove references to pre-gcc5 ABI issues
* ARROW-4165: Move Windows C++ developer guide to Sphinx (from cpp/apidoc/Windows.md)
* ARROW-4547: Update Python development instructions re: producing CUDA-enabled pyarrow
* ARROW-4326 / ARROW-3096: Update Python build instructions re: January 2019 compiler migration

Author: Wes McKinney <[email protected]>

Closes apache#3942 from wesm/developer-docs-0.13 and squashes the following commits:

a3c3dd5 <Wes McKinney> Add some Boost info, misc cleaning
2ccc3de <Wes McKinney> Remove index.md altogether
66da97e <Wes McKinney> Remove unused text from cpp/apidoc/index.md
504bc13 <Wes McKinney> restore 'what's in the arrow libraries' section
8d1f33e <Wes McKinney> Finish initial documentation revamp for 0.13, stopping here
84dd680 <Wes McKinney> Some docs reorg, begin rewriting cpp/README.md into docs/source/developers/cpp.rst
  • Loading branch information
wesm committed Mar 17, 2019
1 parent 9d73e0a commit d94a9fc
Show file tree
Hide file tree
Showing 19 changed files with 1,194 additions and 1,149 deletions.
38 changes: 6 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,18 @@ The reference Arrow libraries contain a number of distinct software components:
library)
- Reference-counted off-heap buffer memory management, for zero-copy memory
sharing and handling memory-mapped files
- Low-overhead IO interfaces to files on disk, HDFS (C++ only)
- IO interfaces to local and remote filesystems
- Self-describing binary wire formats (streaming and batch/file-like) for
remote procedure calls (RPC) and
interprocess communication (IPC)
- Integration tests for verifying binary compatibility between the
implementations (e.g. sending data from Java to C++)
- Conversions to and from other in-memory data structures

## How to Contribute

Please read our latest [project contribution guide][5].

## Getting involved

Even if you do not plan to contribute to Apache Arrow itself or Arrow
Expand All @@ -79,38 +83,8 @@ integrations in other projects, we'd be happy to have you involved:
- [Learn the format][2]
- Contribute code to one of the reference implementations

## How to Contribute

We prefer to receive contributions in the form of GitHub pull requests. Please
send pull requests against the [github.com/apache/arrow][4] repository.

If you are looking for some ideas on what to contribute, check out the [JIRA
issues][3] for the Apache Arrow project. Comment on the issue and/or contact
[[email protected]](https://mail-archives.apache.org/mod_mbox/arrow-dev/)
with your questions and ideas.

If you’d like to report a bug but don’t have time to fix it, you can still post
it on JIRA, or email the mailing list
[[email protected]](https://mail-archives.apache.org/mod_mbox/arrow-dev/)

To contribute a patch:

1. Break your work into small, single-purpose patches if possible. It’s much
harder to merge in a large change with a lot of disjoint features.
2. Create a JIRA for your patch on the [Arrow Project
JIRA](https://issues.apache.org/jira/browse/ARROW).
3. Submit the patch as a GitHub pull request against the master branch. For a
tutorial, see the GitHub guides on forking a repo and sending a pull
request. Prefix your pull request name with the JIRA name (ex:
https://github.com/apache/arrow/pull/240).
4. Make sure that your code passes the unit tests. You can find instructions
how to run the unit tests for each Arrow component in its respective README
file.
5. Add new unit tests for your code.

Thank you in advance for your contributions!

[1]: mailto:[email protected]
[2]: https://github.com/apache/arrow/tree/master/format
[3]: https://issues.apache.org/jira/browse/ARROW
[4]: https://github.com/apache/arrow
[5]: https://github.com/apache/arrow/blob/master/docs/source/developers/contributing.rst
2 changes: 1 addition & 1 deletion ci/conda_env_cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ python
rapidjson
re2
snappy
thrift-cpp
thrift-cpp=0.12.0
zlib
zstd
Loading

0 comments on commit d94a9fc

Please sign in to comment.