You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/12/13 17:56:55 UTC
[GitHub] [arrow] AlenkaF opened a new pull request #11942: ARROW-14762: [Doc] Additional info and resources
AlenkaF opened a new pull request #11942:
URL: https://github.com/apache/arrow/pull/11942
Draft for info and resources
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-1011221219
Benchmark runs are scheduled for baseline = af7668e0e674c0ebbdade4afa3c8d2e2503e04d4 and contender = 7303b51ad2f9ac3f0c59bee7221771552ed4eb46. 7303b51ad2f9ac3f0c59bee7221771552ed4eb46 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/c360a66a17a9443a9f3d8c82881d3e6d...1c173a5cb70b410a8fb9c54181295aad/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/7198a9094a924c0ab1afa0212859d5c1...f9a5a884a48447148be5a8ba9ba0f689/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/fd8ddf06d60a429eabdb1e0151512b46...4f575a69492747e3a6a1ee430b2e7b9f/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r781190097
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we are listing resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ R package has an option of installing the nightly builds which are daily development
Review comment:
```suggestion
The Arrow R package has an option of installing the nightly builds which are daily development
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r782767440
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
Review comment:
Annotation glossary is meant to capture different topics included in the Apache Arrow and present a short explanation and, if possible, a link for more information. What could be included: dependencies, memory management, common terms used in the community, etc.
See this comment: https://github.com/apache/arrow/pull/11942#discussion_r770411667
See similar work:
- https://arrow.apache.org/docs/c_glib/arrow-glib/annotation-glossary.html
- https://docs.python.org/3/glossary.html
- https://link.springer.com/content/pdf/bbm%3A978-1-4419-1318-0%2F1.pdf
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r770411667
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,50 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+Additional information
+----------------------
+
+- `CMake <https://cmake.org/documentation/>`_
+- `Gandiva <https://arrow.apache.org/blog/2018/12/05/gandiva-donation/>`_
+- SIMD
+
+ - `Columnar is Fast section of Apache Arrow Overview <https://arrow.apache.org/overview/>`_
+ - `SIMD on Wikipedia <https://en.wikipedia.org/wiki/SIMD>`_
+
+- Memory management
+
+ - `C++ <https://arrow.apache.org/docs/cpp/memory.html>`_
+ - `Python <https://arrow.apache.org/docs/python/memory.html>`_
+ - `jemalloc <https://arrow.apache.org/blog/2018/07/20/jemalloc/>`_,
+ `mimalloc <https://github.com/microsoft/mimalloc#readme>`_
+ - `Plasma <https://arrow.apache.org/blog/2017/08/08/plasma-in-memory-object-store/>`_
+
+- `Snappy <https://github.com/google/snappy#introduction>`_
Review comment:
I created two JIRA issues [ARROW-15130](https://issues.apache.org/jira/browse/ARROW-15130) and [ARROW-15129](https://issues.apache.org/jira/browse/ARROW-15129) to remove random information listed here. I will link to the Glossary once it is done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r781943911
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ It is possible to install the Arrow R package from the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+
+Recommended books for learning languages
+----------------------------------------
+
+- Slatkin, Brett, *Effective Python: 90 Specific Ways to Write Better Python*, Addison-Wesley Professional, 2019
+- Stroustrup, Bjarne, *A Tour of C++ (Second edition)*, Addison-Wesley, 2018
+- Wickham, Hadley, `R Packages: Organize, Test, Document, and Share Your Code <https://r-pkgs.org/>`_
+- Wickham, Hadley, `Advanced R <https://adv-r.hadley.nz/>`_
Review comment:
Perhaps, yes. There were, though, quite some suggestions to include the resources for earning languages from previous reviews of the guide. Not intended to learn a language from scratch, but to have a reference of which books are recommended by the Arrow developers (to be used as help with structuring the code). Does that makes sense?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r782023020
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ It is possible to install the Arrow R package from the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+
+Recommended books for learning languages
+----------------------------------------
+
+- Slatkin, Brett, *Effective Python: 90 Specific Ways to Write Better Python*, Addison-Wesley Professional, 2019
+- Stroustrup, Bjarne, *A Tour of C++ (Second edition)*, Addison-Wesley, 2018
+- Wickham, Hadley, `R Packages: Organize, Test, Document, and Share Your Code <https://r-pkgs.org/>`_
+- Wickham, Hadley, `Advanced R <https://adv-r.hadley.nz/>`_
Review comment:
Yeah, that does make sense. Perhaps could we just rename this section header then to reflect this? Maybe "Recommended references" or something?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r783012298
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
Review comment:
Ah, I see, great idea! Are we better leaving this placeholder out of here ahead of the release of the first version (with the release I assume)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic closed pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic closed pull request #11942:
URL: https://github.com/apache/arrow/pull/11942
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r778808275
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,41 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
Review comment:
```suggestion
On this page we will list resources that may be relevant or useful for
contributors who want to learn more about different parts of Apache Arrow.
```
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,41 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
Review comment:
I'd be tempted to also add a link to the relevant directory in the codebase here too
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,41 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
Review comment:
Is it worth perhaps adding a bit of an explanation here of what this is?
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,41 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+
+- Nightly builds
Review comment:
How about a bit on what the nightly builds are?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-992727365
https://issues.apache.org/jira/browse/ARROW-14762
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r769822809
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,50 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+Additional information
+----------------------
+
+- `CMake <https://cmake.org/documentation/>`_
+- `Gandiva <https://arrow.apache.org/blog/2018/12/05/gandiva-donation/>`_
+- SIMD
+
+ - `Columnar is Fast section of Apache Arrow Overview <https://arrow.apache.org/overview/>`_
+ - `SIMD on Wikipedia <https://en.wikipedia.org/wiki/SIMD>`_
+
+- Memory management
+
+ - `C++ <https://arrow.apache.org/docs/cpp/memory.html>`_
+ - `Python <https://arrow.apache.org/docs/python/memory.html>`_
+ - `jemalloc <https://arrow.apache.org/blog/2018/07/20/jemalloc/>`_,
+ `mimalloc <https://github.com/microsoft/mimalloc#readme>`_
+ - `Plasma <https://arrow.apache.org/blog/2017/08/08/plasma-in-memory-object-store/>`_
+
+- `Snappy <https://github.com/google/snappy#introduction>`_
Review comment:
The selection was done completely from my side due to the fact I bumped into this group when building PyArrow. I could try to list all of them (will go through the cpp part of the dev docs).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] edponce commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
edponce commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r780839108
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,52 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ In Apache Arrow we use GitHub actions to build and test every pull request that is
+ opened, merged etc. To do so there are workflows created and then run via GitHub actions.
Review comment:
* `GitHub actions` --> `GitHub Actions`
* `opened, merged etc.` --> `opened, merged, etc.`
Suggestion for merging 2nd/3rd sentences:
`Apache Arrow has a set of workflows that run via GitHub Actions to build and test every pull request that is opened, merged, etc.`
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,52 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources that may be relevant or useful for
Review comment:
Why future tense (`we will list`)? Aren't we listing them now?
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,52 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ In Apache Arrow we use GitHub actions to build and test every pull request that is
+ opened, merged etc. To do so there are workflows created and then run via GitHub actions.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ R package has an option of installing the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+.. - Blog post walking through writing an R binding (not yet written)
Review comment:
Is there are JIRA opened for this? If so, then reference it, or maybe add a `TODO` tag.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r782076351
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ It is possible to install the Arrow R package from the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+
+Recommended books for learning languages
+----------------------------------------
+
+- Slatkin, Brett, *Effective Python: 90 Specific Ways to Write Better Python*, Addison-Wesley Professional, 2019
+- Stroustrup, Bjarne, *A Tour of C++ (Second edition)*, Addison-Wesley, 2018
+- Wickham, Hadley, `R Packages: Organize, Test, Document, and Share Your Code <https://r-pkgs.org/>`_
+- Wickham, Hadley, `Advanced R <https://adv-r.hadley.nz/>`_
Review comment:
Sure, will do it as soon as I get back to the computer.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r783220279
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
Review comment:
Sorry, not sure I understand (this part is only a comment/TODO to add the Glossary once the issue ARROW-15130 is closed)? I would not remove it, but could add a TODO to make it clearer?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r783229757
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
Review comment:
Ah, don't worry about
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-1011221219
Benchmark runs are scheduled for baseline = af7668e0e674c0ebbdade4afa3c8d2e2503e04d4 and contender = 7303b51ad2f9ac3f0c59bee7221771552ed4eb46. 7303b51ad2f9ac3f0c59bee7221771552ed4eb46 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/c360a66a17a9443a9f3d8c82881d3e6d...1c173a5cb70b410a8fb9c54181295aad/)
[Failed :arrow_down:0.9% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/7198a9094a924c0ab1afa0212859d5c1...f9a5a884a48447148be5a8ba9ba0f689/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/fd8ddf06d60a429eabdb1e0151512b46...4f575a69492747e3a6a1ee430b2e7b9f/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r781190097
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we are listing resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ R package has an option of installing the nightly builds which are daily development
Review comment:
```suggestion
It is possible to install the Arrow R package from the nightly builds which are daily development
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r782270487
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
Review comment:
What's this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r769763217
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,50 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources interesting for a contributor
+that is not yet acquainted with different parts of Apache Arrow.
+
+Additional information
+----------------------
+
+- `CMake <https://cmake.org/documentation/>`_
+- `Gandiva <https://arrow.apache.org/blog/2018/12/05/gandiva-donation/>`_
+- SIMD
+
+ - `Columnar is Fast section of Apache Arrow Overview <https://arrow.apache.org/overview/>`_
+ - `SIMD on Wikipedia <https://en.wikipedia.org/wiki/SIMD>`_
+
+- Memory management
+
+ - `C++ <https://arrow.apache.org/docs/cpp/memory.html>`_
+ - `Python <https://arrow.apache.org/docs/python/memory.html>`_
+ - `jemalloc <https://arrow.apache.org/blog/2018/07/20/jemalloc/>`_,
+ `mimalloc <https://github.com/microsoft/mimalloc#readme>`_
+ - `Plasma <https://arrow.apache.org/blog/2017/08/08/plasma-in-memory-object-store/>`_
+
+- `Snappy <https://github.com/google/snappy#introduction>`_
Review comment:
I'm not sure I understand the selection which is done here. Arrow has many optional dependencies (mimalloc, Snappy...) and it's not obvious that giving links to only a couple of them is useful.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r781330207
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we have listed resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ Apache Arrow has a set of workflows that run via GitHub Actions to build and test
+ every pull request that is opened, merged, etc.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ It is possible to install the Arrow R package from the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+
+Recommended books for learning languages
+----------------------------------------
+
+- Slatkin, Brett, *Effective Python: 90 Specific Ways to Write Better Python*, Addison-Wesley Professional, 2019
+- Stroustrup, Bjarne, *A Tour of C++ (Second edition)*, Addison-Wesley, 2018
+- Wickham, Hadley, `R Packages: Organize, Test, Document, and Share Your Code <https://r-pkgs.org/>`_
+- Wickham, Hadley, `Advanced R <https://adv-r.hadley.nz/>`_
Review comment:
I wonder if this might be out of the scope of this guide?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r781235986
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,51 @@
************************************
Additional information and resources
************************************
+
+On this page we are listing resources that may be relevant or useful for
Review comment:
```suggestion
On this page we have listed resources that may be relevant or useful for
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-1011221219
Benchmark runs are scheduled for baseline = af7668e0e674c0ebbdade4afa3c8d2e2503e04d4 and contender = 7303b51ad2f9ac3f0c59bee7221771552ed4eb46. 7303b51ad2f9ac3f0c59bee7221771552ed4eb46 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/c360a66a17a9443a9f3d8c82881d3e6d...1c173a5cb70b410a8fb9c54181295aad/)
[Failed :arrow_down:0.9% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/7198a9094a924c0ab1afa0212859d5c1...f9a5a884a48447148be5a8ba9ba0f689/)
[Finished :arrow_down:0.09% :arrow_up:0.0%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/fd8ddf06d60a429eabdb1e0151512b46...4f575a69492747e3a6a1ee430b2e7b9f/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#discussion_r780968335
##########
File path: docs/source/developers/guide/resources.rst
##########
@@ -27,3 +27,52 @@
************************************
Additional information and resources
************************************
+
+On this page we will list resources that may be relevant or useful for
+contributors who want to learn more about different parts of Apache Arrow.
+
+.. Annotation Glossary
+.. -------------------
+.. ARROW-15130
+
+Additional information
+----------------------
+
+- GitHub Actions
+
+ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform.
+ In Apache Arrow we use GitHub actions to build and test every pull request that is
+ opened, merged etc. To do so there are workflows created and then run via GitHub actions.
+
+ - `Apache Arrow Actions on GitHub <https://github.com/apache/arrow/actions>`_
+ - `Location of the workflows in Arrow: arrow/.github/workflows/ <https://github.com/apache/arrow/tree/master/.github/workflows>`_
+ - `GitHub Documentation on GitHub Actions <https://docs.github.com/en/actions>`_
+ .. ARROW-13841: [Doc] Document the different subcomponents that make up the CI and how they fit together:
+ .. https://github.com/apache/arrow/pull/11821
+
+- Nightly builds
+
+ R package has an option of installing the nightly builds which are daily development
+ builds of the R package and are not the official releases. See more on the
+ `Install R package article <https://ursalabs.org/arrow-r-nightly/articles/install.html#install-the-nightly-build>`_.
+
+- `Apache Arrow releases <https://arrow.apache.org/release/>`_
+
+Other resources
+---------------
+
+- :ref:`contributing`
+- `Arrow R Developer Guide <https://arrow.apache.org/docs/r/articles/developing.html>`_
+- `Writing Bindings article for R package <https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
+
+- `Tidyverse: Make a reprex <https://www.tidyverse.org/help/#reprex>`_
+- `Craft Minimal Bug Reports by Matthew Rocklin <https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
+.. - Blog post walking through writing an R binding (not yet written)
Review comment:
Oh, my mistake, this is a leftover of a merge conflict thing. The article is written and the link is added to this PR in line 66. Will remove this. Thanks for catching it!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-1010716848
@thisisnic gave a short description, hope it helps!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #11942: ARROW-14762: [Doc] Additional info and resources
Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #11942:
URL: https://github.com/apache/arrow/pull/11942#issuecomment-1011221219
Benchmark runs are scheduled for baseline = af7668e0e674c0ebbdade4afa3c8d2e2503e04d4 and contender = 7303b51ad2f9ac3f0c59bee7221771552ed4eb46. 7303b51ad2f9ac3f0c59bee7221771552ed4eb46 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/c360a66a17a9443a9f3d8c82881d3e6d...1c173a5cb70b410a8fb9c54181295aad/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/7198a9094a924c0ab1afa0212859d5c1...f9a5a884a48447148be5a8ba9ba0f689/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/fd8ddf06d60a429eabdb1e0151512b46...4f575a69492747e3a6a1ee430b2e7b9f/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org