Skip to content

Commit

Permalink
docs: add FAQs about releases (#1151)
Browse files Browse the repository at this point in the history
Fixes #1090.
Fixes #1092.
  • Loading branch information
lidavidm authored Oct 2, 2023
1 parent 79c7a3b commit 213cb41
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ ADBC versions the API standard and the implementing libraries separately.
The API standard (version 1.0.0) is considered stable, but enhancements may be made.

Libraries are under development.
For more details, see the [documentation](https://arrow.apache.org/adbc/main/driver/status.html).
For more details, see the [documentation](https://arrow.apache.org/adbc/main/driver/status.html), or read the [changelog](CHANGELOG.md).

## Installation

Expand Down
5 changes: 3 additions & 2 deletions docs/source/development/nightly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ https://gemfury.com/arrow-adbc-nightlies
Example::

pip install \
--extra-index-url https://repo.fury.io/arrow-adbc-nightlies \
--pre \
--index-url https://repo.fury.io/arrow-adbc-nightlies \
adbc-driver-manager

.. list-table:: Supported platforms for nightly Python wheels
Expand All @@ -89,5 +90,5 @@ Example::
- Yes ✅

* - Windows
- No
- Yes
- No ❌
9 changes: 9 additions & 0 deletions docs/source/driver/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ Installation

See individual driver pages in the sidebar for specific installation instructions.

Source
======

The latest source release can be downloaded from the `Apache mirrors`_.
Compilation instructions can be found in `CONTRIBUTING.md`_.

.. _Apache mirrors: https://www.apache.org/dyn/closer.lua/arrow/
.. _CONTRIBUTING.md: https://github.com/apache/arrow-adbc/blob/main/CONTRIBUTING.md

C/C++
=====

Expand Down
20 changes: 20 additions & 0 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,23 @@ For a project that does try to tackle the problem of defining a
vendor-independent query language, see Substrait_.

.. _Substrait: https://substrait.io/

When is the next release?
=========================

There is no fixed release cadence. We currently target releases every 6-8
weeks.

Once a release is tagged, the project then gives at least 72 hours for the
`Arrow PMC`_ to vote on the release. Once the vote concludes, then packages
are uploaded to places like PyPI, conda-forge, and so on. So even after a
release, it may take some time for binary packages to be available.

.. _Arrow PMC: https://arrow.apache.org/committers/

When/where is 1.0? Is this project ready?
=========================================

At this time, there is no formal date planned for a "1.0" release of the
implementation. :doc:`driver/status` has a rough overview of the status of
individual driver implementations.

0 comments on commit 213cb41

Please sign in to comment.